From ce31d83e8c7f509ace58af1ae99be0731f115cc3 Mon Sep 17 00:00:00 2001 From: ivobenedito Date: Mon, 28 Jan 2013 16:28:32 +0000 Subject: [PATCH 1/5] implemented config file with active_support/configurable --- lib/api_taster.rb | 1 + lib/api_taster/config.rb | 39 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 40 insertions(+) create mode 100644 lib/api_taster/config.rb diff --git a/lib/api_taster.rb b/lib/api_taster.rb index 7add34f..5b0f7e8 100644 --- a/lib/api_taster.rb +++ b/lib/api_taster.rb @@ -2,6 +2,7 @@ require 'bootstrap-sass' require 'remotipart' require 'active_support/dependencies' +require 'api_taster/config' require 'api_taster/engine' require 'api_taster/route' require 'api_taster/mapper' diff --git a/lib/api_taster/config.rb b/lib/api_taster/config.rb new file mode 100644 index 0000000..32cbf71 --- /dev/null +++ b/lib/api_taster/config.rb @@ -0,0 +1,39 @@ +require 'active_support/configurable' + +module ApiTaster + # Configures global settings for ApiTaster + # ApiTaster.configure do |config| + # config.title = 'My Application Name' + # end + def self.configure(&block) + yield @config ||= ApiTaster::Configuration.new + end + + # Global settings for ApiTaster + def self.config + @config + end + + class Configuration + include ActiveSupport::Configurable + + config_accessor :title + config_accessor :include_missing_definitions + config_accessor :include_obsolete_definitions + + def param_name + config.param_name.respond_to?(:call) ? config.param_name.call : config.param_name + end + + # define param_name writer (copied from AS::Configurable) + writer, line = 'def param_name=(value); config.param_name = value; end', __LINE__ + singleton_class.class_eval writer, __FILE__, line + class_eval writer, __FILE__, line + end + + configure do |config| + config.title = 'API Taster' + config.include_missing_definitions = true + config.include_obsolete_definitions = true + end +end From 8cd27484f309a216b251fe364ac53e73754c17df Mon Sep 17 00:00:00 2001 From: ivobenedito Date: Mon, 28 Jan 2013 16:29:24 +0000 Subject: [PATCH 2/5] cleanup/refactor to support parameterized obsolete and missing definitions --- .../api_taster/routes_controller.rb | 11 ++++++++-- app/views/api_taster/routes/index.html.erb | 20 ++++++++++--------- 2 files changed, 20 insertions(+), 11 deletions(-) diff --git a/app/controllers/api_taster/routes_controller.rb b/app/controllers/api_taster/routes_controller.rb index e5d8678..414aa99 100644 --- a/app/controllers/api_taster/routes_controller.rb +++ b/app/controllers/api_taster/routes_controller.rb @@ -1,11 +1,10 @@ module ApiTaster class RoutesController < ApiTaster::ApplicationController before_filter :map_routes + helper_method :missing_definitions?, :obsolete_definitions? def index @routes = Route.grouped_routes - @has_missing_definitions = Route.missing_definitions.present? - @has_obsolete_definitions = Route.obsolete_definitions.present? end def show @@ -27,5 +26,13 @@ def obsolete_definitions def map_routes Route.map_routes end + + def missing_definitions? + Route.missing_definitions.present? && ApiTaster.config.include_missing_definitions + end + + def obsolete_definitions? + Route.obsolete_definitions.present? && ApiTaster.config.include_obsolete_definitions + end end end diff --git a/app/views/api_taster/routes/index.html.erb b/app/views/api_taster/routes/index.html.erb index 8e99942..3f574ca 100644 --- a/app/views/api_taster/routes/index.html.erb +++ b/app/views/api_taster/routes/index.html.erb @@ -2,19 +2,17 @@
    - <% if @has_missing_definitions || @has_obsolete_definitions %> + <% if missing_definitions? || obsolete_definitions? %>
  • Information
    • - <% if @has_missing_definitions %> + <% if missing_definitions? %> <%= render 'information_warning_li', :text => 'Missing Definitions Detected', - :path => missing_definitions_routes_path - %> + :path => missing_definitions_routes_path %> <% end %> - <% if @has_obsolete_definitions %> + <% if obsolete_defitions? %> <%= render 'information_warning_li', :text => 'Obsolete Definitions Detected', - :path => obsolete_definitions_routes_path - %> + :path => obsolete_definitions_routes_path %> <% end %> <% end %> <% @routes.each do |controller, routes| %> @@ -23,7 +21,9 @@
  • - <%= route[:verb] %> + + <%= route[:verb] %> +
    <%= route[:path] %>     @@ -36,7 +36,9 @@
    -

    Select an API endpoint on the left to get started. :)

    +

    + To get started, click on any link at left, enter search criteria in the fields on the right and Submit! +

    From ad36f68d470b4e66223ceb66ebeb425dd8cb4c53 Mon Sep 17 00:00:00 2001 From: ivobenedito Date: Mon, 28 Jan 2013 16:52:09 +0000 Subject: [PATCH 3/5] added call_to_action, app_title, app_url --- app/views/api_taster/routes/index.html.erb | 6 ++---- app/views/layouts/api_taster/application.html.erb | 9 +++++++-- lib/api_taster/config.rb | 3 +++ 3 files changed, 12 insertions(+), 6 deletions(-) diff --git a/app/views/api_taster/routes/index.html.erb b/app/views/api_taster/routes/index.html.erb index 3f574ca..e09c9a2 100644 --- a/app/views/api_taster/routes/index.html.erb +++ b/app/views/api_taster/routes/index.html.erb @@ -9,7 +9,7 @@ :text => 'Missing Definitions Detected', :path => missing_definitions_routes_path %> <% end %> - <% if obsolete_defitions? %> + <% if obsolete_definitions? %> <%= render 'information_warning_li', :text => 'Obsolete Definitions Detected', :path => obsolete_definitions_routes_path %> @@ -36,9 +36,7 @@
    -

    - To get started, click on any link at left, enter search criteria in the fields on the right and Submit! -

    +

    <%= ApiTaster.config.call_to_action %>

    diff --git a/app/views/layouts/api_taster/application.html.erb b/app/views/layouts/api_taster/application.html.erb index 3251c50..dfa8ce9 100644 --- a/app/views/layouts/api_taster/application.html.erb +++ b/app/views/layouts/api_taster/application.html.erb @@ -11,12 +11,17 @@
      -
    • API Taster
      • +
    • + <%= link_to ApiTaster.config.title, root_path, class: 'brand' %> +
    diff --git a/lib/api_taster/config.rb b/lib/api_taster/config.rb index 32cbf71..6ecadfc 100644 --- a/lib/api_taster/config.rb +++ b/lib/api_taster/config.rb @@ -33,6 +33,9 @@ def param_name configure do |config| config.title = 'API Taster' + config.call_to_action = 'Select an API endpoint on the left to get started. :)' + config.app_title = Rails.application.class.name + config.app_url = '/' config.include_missing_definitions = true config.include_obsolete_definitions = true end From 3ea3754b7a166fcb116aafb91ffad6da75ace2b3 Mon Sep 17 00:00:00 2001 From: ivobenedito Date: Mon, 28 Jan 2013 17:03:27 +0000 Subject: [PATCH 4/5] bugfixed configuration --- lib/api_taster/config.rb | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/lib/api_taster/config.rb b/lib/api_taster/config.rb index 6ecadfc..e1d9c47 100644 --- a/lib/api_taster/config.rb +++ b/lib/api_taster/config.rb @@ -18,6 +18,9 @@ class Configuration include ActiveSupport::Configurable config_accessor :title + config_accessor :call_to_action + config_accessor :app_title + config_accessor :app_url config_accessor :include_missing_definitions config_accessor :include_obsolete_definitions @@ -34,7 +37,7 @@ def param_name configure do |config| config.title = 'API Taster' config.call_to_action = 'Select an API endpoint on the left to get started. :)' - config.app_title = Rails.application.class.name + config.app_title = 'Application' config.app_url = '/' config.include_missing_definitions = true config.include_obsolete_definitions = true From e53cbcc4d6a2df9cf2578722aec80c9c6ca8f9b8 Mon Sep 17 00:00:00 2001 From: ivobenedito Date: Mon, 28 Jan 2013 17:48:46 +0000 Subject: [PATCH 5/5] bump version of bootstrap sass @ gemspec --- api_taster.gemspec | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/api_taster.gemspec b/api_taster.gemspec index 4405d68..5728a79 100644 --- a/api_taster.gemspec +++ b/api_taster.gemspec @@ -16,8 +16,9 @@ Gem::Specification.new do |s| s.add_dependency 'rails', '>= 3.1.0' s.add_dependency 'jquery-rails' - s.add_dependency 'sass-rails' - s.add_dependency 'bootstrap-sass', '~> 2.1' + s.add_dependency 'sass-rails', '~> 3.2' + s.add_dependency 'bootstrap-sass', '~> 2.2.2.0' + s.add_dependency 'redcarpet' s.add_dependency 'remotipart', '~> 1.0'