short_circuit-cj 1.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (43) hide show
  1. checksums.yaml +7 -0
  2. data/MIT-LICENSE +20 -0
  3. data/README.md +113 -0
  4. data/lib/short_circuit.rb +7 -0
  5. data/lib/short_circuit/presentable.rb +26 -0
  6. data/lib/short_circuit/presenter.rb +38 -0
  7. data/lib/short_circuit/version.rb +3 -0
  8. data/spec/dummy/README.rdoc +28 -0
  9. data/spec/dummy/Rakefile +6 -0
  10. data/spec/dummy/app/assets/javascripts/application.js +13 -0
  11. data/spec/dummy/app/assets/stylesheets/application.css +13 -0
  12. data/spec/dummy/app/controllers/application_controller.rb +5 -0
  13. data/spec/dummy/app/helpers/application_helper.rb +2 -0
  14. data/spec/dummy/app/views/layouts/application.html.erb +14 -0
  15. data/spec/dummy/bin/bundle +3 -0
  16. data/spec/dummy/bin/rails +4 -0
  17. data/spec/dummy/bin/rake +4 -0
  18. data/spec/dummy/config.ru +4 -0
  19. data/spec/dummy/config/application.rb +28 -0
  20. data/spec/dummy/config/boot.rb +5 -0
  21. data/spec/dummy/config/database.yml +25 -0
  22. data/spec/dummy/config/environment.rb +5 -0
  23. data/spec/dummy/config/environments/development.rb +29 -0
  24. data/spec/dummy/config/environments/production.rb +80 -0
  25. data/spec/dummy/config/environments/test.rb +36 -0
  26. data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
  27. data/spec/dummy/config/initializers/filter_parameter_logging.rb +4 -0
  28. data/spec/dummy/config/initializers/inflections.rb +16 -0
  29. data/spec/dummy/config/initializers/mime_types.rb +5 -0
  30. data/spec/dummy/config/initializers/secret_token.rb +12 -0
  31. data/spec/dummy/config/initializers/session_store.rb +3 -0
  32. data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
  33. data/spec/dummy/config/locales/en.yml +23 -0
  34. data/spec/dummy/config/routes.rb +56 -0
  35. data/spec/dummy/db/test.sqlite3 +0 -0
  36. data/spec/dummy/public/404.html +58 -0
  37. data/spec/dummy/public/422.html +58 -0
  38. data/spec/dummy/public/500.html +57 -0
  39. data/spec/dummy/public/favicon.ico +0 -0
  40. data/spec/short_circuit/presentable_spec.rb +66 -0
  41. data/spec/short_circuit/presenter_spec.rb +56 -0
  42. data/spec/spec_helper.rb +19 -0
  43. metadata +148 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 8733b377c467218130cffad542584f043b80e77b
4
+ data.tar.gz: 5139424a783effc354c7ce990251127c89c9af7e
5
+ SHA512:
6
+ metadata.gz: 685ff084a1d27fa5b8f5456e43f9b0758058ad0cf9da58f107e54884bed0f42dec2ff5564b96719176c16e19bfdd7c8ba3411e5b97e71ab2e5f4285af4dbb6ed
7
+ data.tar.gz: c7b69dd3d078dc42b2f891d9c58ac31401d82cbb9744040398c9a722ca065e7bb94b9a328499d295f66b514441b3a2ee6f975a0bad97f6b01ea0962e714aa03a
data/MIT-LICENSE ADDED
@@ -0,0 +1,20 @@
1
+ Copyright 2014 Jim Pruetting
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,113 @@
1
+ short_circuit
2
+ =============
3
+
4
+ [![Gem Version](https://badge.fury.io/rb/short_circuit.png)](http://badge.fury.io/rb/short_circuit) [![Build Status](https://travis-ci.org/jpruetting/short_circuit.png?branch=master)](https://travis-ci.org/jpruetting/short_circuit) [![Code Climate](https://codeclimate.com/github/jpruetting/short_circuit.png)](https://codeclimate.com/github/jpruetting/short_circuit)
5
+
6
+ Short Circuit adds simple presenters for Rails views.
7
+
8
+
9
+ Usage
10
+ ======
11
+
12
+ Install the gem in your Gemfile:
13
+
14
+ ```ruby
15
+ gem 'short_circuit'
16
+ ```
17
+
18
+ Include short_circuit in your model:
19
+
20
+ ```ruby
21
+ # app/models/user.rb
22
+
23
+ class User < ActiveRecord::Base
24
+ include ShortCircuit::Presentable
25
+
26
+ attr_accessible :first_name, :last_name, :job_title, :member_since
27
+ end
28
+ ```
29
+
30
+ Create a presenter:
31
+
32
+ ```ruby
33
+ # app/presenters/user_presenter.rb
34
+
35
+ class UserPresenter < ShortCircuit::Presenter
36
+ def first_name
37
+ @user.first_name.titleize
38
+ end
39
+
40
+ def full_name
41
+ "#{first_name} #{last_name}"
42
+ end
43
+
44
+ def job_title
45
+ @user.job_title || 'not listed'
46
+ end
47
+
48
+ def member_since
49
+ @user.member_since.to_formatted_s(:long)
50
+ end
51
+
52
+ def error_response(method, *args, &block)
53
+ link_to 'N/A', root_path
54
+ end
55
+ end
56
+ ```
57
+
58
+ No additional controller code is necessary. Retrieve the model as you normally would:
59
+
60
+ ```ruby
61
+ # app/controllers/users_controller.rb
62
+
63
+ class UsersController < ApplicationController
64
+ def show
65
+ @user = User.find(params['id'])
66
+ end
67
+ end
68
+ ```
69
+
70
+ In the view, you don't need to instantiate any presenter/decorator objects, just use the model:
71
+
72
+ ```ruby
73
+ # Normal method vs presenter method:
74
+ @user.first_name # john
75
+ @user.present :first_name # John
76
+
77
+
78
+ # Missing presenter method is delegated to model:
79
+ @user.last_name # smith
80
+ @user.present :last_name # smith
81
+
82
+
83
+ # Method defined on presenter object:
84
+ @user.full_name # NoMethodError
85
+ @user.present :full_name # John smith
86
+
87
+
88
+ # Formatted data returned by presenter method:
89
+ @user.member_since # 2013-02-28 20:46:32 UTC
90
+ @user.present :member_since # February 28, 2013 20:46
91
+
92
+
93
+ # Presenter method prevents nil error by returning default data:
94
+ @user.job_title.upcase # undefined method 'upcase' for nil:NilClass
95
+ @user.present(:job_title).upcase # NOT LISTED
96
+
97
+
98
+ # Presenter method silences nil error and returns alternative content:
99
+ @user.not_a_real_method # NoMethodError
100
+ @user.present :not_a_real_method # <a href="/">N/A</a>
101
+
102
+
103
+ # Present! method does not silence errors:
104
+ @user.present! :not_a_real_method # NoMethodError
105
+ ```
106
+
107
+ Design goals
108
+ ============
109
+ * Minimize project size and scope
110
+ * Preserve direct access to model attributes
111
+ * Create a separate access point for presenter methods
112
+ * Silence accessor errors by default
113
+ * Delegate missing presenter methods to the model object
@@ -0,0 +1,7 @@
1
+ module ShortCircuit
2
+ require 'active_support/all'
3
+
4
+ require 'short_circuit/version'
5
+ require 'short_circuit/presenter'
6
+ require 'short_circuit/presentable'
7
+ end
@@ -0,0 +1,26 @@
1
+ module ShortCircuit
2
+ module Presentable
3
+ def presenter
4
+ @presenter ||= find_presenter
5
+ end
6
+
7
+ def present(method, *args, &block)
8
+ present!(method, *args, &block)
9
+ rescue Exception => error
10
+ presenter.error_response(error, method, *args, &block)
11
+ end
12
+
13
+ def present!(method, *args, &block)
14
+ presenter.send(method, *args, &block)
15
+ end
16
+
17
+ private
18
+
19
+ def find_presenter
20
+ presenter_class_name = "#{self.class.name}Presenter"
21
+ presenter_class = Object.const_get(presenter_class_name)
22
+
23
+ presenter_class.new(self)
24
+ end
25
+ end
26
+ end
@@ -0,0 +1,38 @@
1
+ # require 'delegate'
2
+
3
+ module ShortCircuit
4
+ class Presenter < SimpleDelegator
5
+ # delegate :url_helpers, to: 'Rails.application.routes'
6
+
7
+ def initialize(presentable_object)
8
+ instance_variable_set(
9
+ "@#{presentable_object.class.to_s.gsub(/.+::/, '').underscore}",
10
+ presentable_object)
11
+
12
+ super(presentable_object)
13
+ end
14
+
15
+ def error_response(error, method, *args, &block)
16
+ ''
17
+ end
18
+
19
+ # private
20
+ #
21
+ # def controller_helpers
22
+ # ApplicationController.helpers
23
+ # end
24
+ #
25
+ # def method_missing(method, *args, &block)
26
+ # puts '====================='
27
+ # puts "#{method}"
28
+ # puts '====================='
29
+ # if controller_helpers.respond_to?(method)
30
+ # controller_helpers.send(method, *args, &block)
31
+ # elsif url_helpers.respond_to?(method)
32
+ # url_helpers.send(method, *args, &block)
33
+ # else
34
+ # super(method, *args, &block)
35
+ # end
36
+ # end
37
+ end
38
+ end
@@ -0,0 +1,3 @@
1
+ module ShortCircuit
2
+ VERSION = '1.0.1'
3
+ end
@@ -0,0 +1,28 @@
1
+ == README
2
+
3
+ This README would normally document whatever steps are necessary to get the
4
+ application up and running.
5
+
6
+ Things you may want to cover:
7
+
8
+ * Ruby version
9
+
10
+ * System dependencies
11
+
12
+ * Configuration
13
+
14
+ * Database creation
15
+
16
+ * Database initialization
17
+
18
+ * How to run the test suite
19
+
20
+ * Services (job queues, cache servers, search engines, etc.)
21
+
22
+ * Deployment instructions
23
+
24
+ * ...
25
+
26
+
27
+ Please feel free to use a different markup language if you do not plan to run
28
+ <tt>rake doc:app</tt>.
@@ -0,0 +1,6 @@
1
+ # Add your own tasks in files placed in lib/tasks ending in .rake,
2
+ # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
3
+
4
+ require File.expand_path('../config/application', __FILE__)
5
+
6
+ Dummy::Application.load_tasks
@@ -0,0 +1,13 @@
1
+ // This is a manifest file that'll be compiled into application.js, which will include all the files
2
+ // listed below.
3
+ //
4
+ // Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
5
+ // or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
6
+ //
7
+ // It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
8
+ // compiled file.
9
+ //
10
+ // Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
11
+ // about supported directives.
12
+ //
13
+ //= require_tree .
@@ -0,0 +1,13 @@
1
+ /*
2
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
3
+ * listed below.
4
+ *
5
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
6
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
7
+ *
8
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
9
+ * compiled file, but it's generally better to create a new file per style scope.
10
+ *
11
+ *= require_self
12
+ *= require_tree .
13
+ */
@@ -0,0 +1,5 @@
1
+ class ApplicationController < ActionController::Base
2
+ # Prevent CSRF attacks by raising an exception.
3
+ # For APIs, you may want to use :null_session instead.
4
+ protect_from_forgery with: :exception
5
+ end
@@ -0,0 +1,2 @@
1
+ module ApplicationHelper
2
+ end
@@ -0,0 +1,14 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>Dummy</title>
5
+ <%= stylesheet_link_tag "application", media: "all", "data-turbolinks-track" => true %>
6
+ <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
7
+ <%= csrf_meta_tags %>
8
+ </head>
9
+ <body>
10
+
11
+ <%= yield %>
12
+
13
+ </body>
14
+ </html>
@@ -0,0 +1,3 @@
1
+ #!/usr/bin/env ruby
2
+ ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
3
+ load Gem.bin_path('bundler', 'bundle')
@@ -0,0 +1,4 @@
1
+ #!/usr/bin/env ruby
2
+ APP_PATH = File.expand_path('../../config/application', __FILE__)
3
+ require_relative '../config/boot'
4
+ require 'rails/commands'
@@ -0,0 +1,4 @@
1
+ #!/usr/bin/env ruby
2
+ require_relative '../config/boot'
3
+ require 'rake'
4
+ Rake.application.run
@@ -0,0 +1,4 @@
1
+ # This file is used by Rack-based servers to start the application.
2
+
3
+ require ::File.expand_path('../config/environment', __FILE__)
4
+ run Rails.application
@@ -0,0 +1,28 @@
1
+ require File.expand_path('../boot', __FILE__)
2
+
3
+ # Pick the frameworks you want:
4
+ require "active_record/railtie"
5
+ require "action_controller/railtie"
6
+ require "action_mailer/railtie"
7
+ require "sprockets/railtie"
8
+ # require "rails/test_unit/railtie"
9
+
10
+ Bundler.require(*Rails.groups)
11
+ require "short_circuit"
12
+
13
+ module Dummy
14
+ class Application < Rails::Application
15
+ # Settings in config/environments/* take precedence over those specified here.
16
+ # Application configuration should go into files in config/initializers
17
+ # -- all .rb files in that directory are automatically loaded.
18
+
19
+ # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
20
+ # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
21
+ # config.time_zone = 'Central Time (US & Canada)'
22
+
23
+ # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
24
+ # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
25
+ # config.i18n.default_locale = :de
26
+ end
27
+ end
28
+
@@ -0,0 +1,5 @@
1
+ # Set up gems listed in the Gemfile.
2
+ ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
3
+
4
+ require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
5
+ $LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)
@@ -0,0 +1,25 @@
1
+ # SQLite version 3.x
2
+ # gem install sqlite3
3
+ #
4
+ # Ensure the SQLite 3 gem is defined in your Gemfile
5
+ # gem 'sqlite3'
6
+ development:
7
+ adapter: sqlite3
8
+ database: db/development.sqlite3
9
+ pool: 5
10
+ timeout: 5000
11
+
12
+ # Warning: The database defined as "test" will be erased and
13
+ # re-generated from your development database when you run "rake".
14
+ # Do not set this db to the same as development or production.
15
+ test:
16
+ adapter: sqlite3
17
+ database: db/test.sqlite3
18
+ pool: 5
19
+ timeout: 5000
20
+
21
+ production:
22
+ adapter: sqlite3
23
+ database: db/production.sqlite3
24
+ pool: 5
25
+ timeout: 5000
@@ -0,0 +1,5 @@
1
+ # Load the Rails application.
2
+ require File.expand_path('../application', __FILE__)
3
+
4
+ # Initialize the Rails application.
5
+ Dummy::Application.initialize!
@@ -0,0 +1,29 @@
1
+ Dummy::Application.configure do
2
+ # Settings specified here will take precedence over those in config/application.rb.
3
+
4
+ # In the development environment your application's code is reloaded on
5
+ # every request. This slows down response time but is perfect for development
6
+ # since you don't have to restart the web server when you make code changes.
7
+ config.cache_classes = false
8
+
9
+ # Do not eager load code on boot.
10
+ config.eager_load = false
11
+
12
+ # Show full error reports and disable caching.
13
+ config.consider_all_requests_local = true
14
+ config.action_controller.perform_caching = false
15
+
16
+ # Don't care if the mailer can't send.
17
+ config.action_mailer.raise_delivery_errors = false
18
+
19
+ # Print deprecation notices to the Rails logger.
20
+ config.active_support.deprecation = :log
21
+
22
+ # Raise an error on page load if there are pending migrations
23
+ config.active_record.migration_error = :page_load
24
+
25
+ # Debug mode disables concatenation and preprocessing of assets.
26
+ # This option may cause significant delays in view rendering with a large
27
+ # number of complex assets.
28
+ config.assets.debug = true
29
+ end
@@ -0,0 +1,80 @@
1
+ Dummy::Application.configure do
2
+ # Settings specified here will take precedence over those in config/application.rb.
3
+
4
+ # Code is not reloaded between requests.
5
+ config.cache_classes = true
6
+
7
+ # Eager load code on boot. This eager loads most of Rails and
8
+ # your application in memory, allowing both thread web servers
9
+ # and those relying on copy on write to perform better.
10
+ # Rake tasks automatically ignore this option for performance.
11
+ config.eager_load = true
12
+
13
+ # Full error reports are disabled and caching is turned on.
14
+ config.consider_all_requests_local = false
15
+ config.action_controller.perform_caching = true
16
+
17
+ # Enable Rack::Cache to put a simple HTTP cache in front of your application
18
+ # Add `rack-cache` to your Gemfile before enabling this.
19
+ # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
20
+ # config.action_dispatch.rack_cache = true
21
+
22
+ # Disable Rails's static asset server (Apache or nginx will already do this).
23
+ config.serve_static_assets = false
24
+
25
+ # Compress JavaScripts and CSS.
26
+ config.assets.js_compressor = :uglifier
27
+ # config.assets.css_compressor = :sass
28
+
29
+ # Do not fallback to assets pipeline if a precompiled asset is missed.
30
+ config.assets.compile = false
31
+
32
+ # Generate digests for assets URLs.
33
+ config.assets.digest = true
34
+
35
+ # Version of your assets, change this if you want to expire all your assets.
36
+ config.assets.version = '1.0'
37
+
38
+ # Specifies the header that your server uses for sending files.
39
+ # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
40
+ # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
41
+
42
+ # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
43
+ # config.force_ssl = true
44
+
45
+ # Set to :debug to see everything in the log.
46
+ config.log_level = :info
47
+
48
+ # Prepend all log lines with the following tags.
49
+ # config.log_tags = [ :subdomain, :uuid ]
50
+
51
+ # Use a different logger for distributed setups.
52
+ # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
53
+
54
+ # Use a different cache store in production.
55
+ # config.cache_store = :mem_cache_store
56
+
57
+ # Enable serving of images, stylesheets, and JavaScripts from an asset server.
58
+ # config.action_controller.asset_host = "http://assets.example.com"
59
+
60
+ # Precompile additional assets.
61
+ # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
62
+ # config.assets.precompile += %w( search.js )
63
+
64
+ # Ignore bad email addresses and do not raise email delivery errors.
65
+ # Set this to true and configure the email server for immediate delivery to raise delivery errors.
66
+ # config.action_mailer.raise_delivery_errors = false
67
+
68
+ # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
69
+ # the I18n.default_locale when a translation can not be found).
70
+ config.i18n.fallbacks = true
71
+
72
+ # Send deprecation notices to registered listeners.
73
+ config.active_support.deprecation = :notify
74
+
75
+ # Disable automatic flushing of the log to improve performance.
76
+ # config.autoflush_log = false
77
+
78
+ # Use default logging formatter so that PID and timestamp are not suppressed.
79
+ config.log_formatter = ::Logger::Formatter.new
80
+ end
@@ -0,0 +1,36 @@
1
+ Dummy::Application.configure do
2
+ # Settings specified here will take precedence over those in config/application.rb.
3
+
4
+ # The test environment is used exclusively to run your application's
5
+ # test suite. You never need to work with it otherwise. Remember that
6
+ # your test database is "scratch space" for the test suite and is wiped
7
+ # and recreated between test runs. Don't rely on the data there!
8
+ config.cache_classes = true
9
+
10
+ # Do not eager load code on boot. This avoids loading your whole application
11
+ # just for the purpose of running a single test. If you are using a tool that
12
+ # preloads Rails for running tests, you may have to set it to true.
13
+ config.eager_load = false
14
+
15
+ # Configure static asset server for tests with Cache-Control for performance.
16
+ config.serve_static_assets = true
17
+ config.static_cache_control = "public, max-age=3600"
18
+
19
+ # Show full error reports and disable caching.
20
+ config.consider_all_requests_local = true
21
+ config.action_controller.perform_caching = false
22
+
23
+ # Raise exceptions instead of rendering exception templates.
24
+ config.action_dispatch.show_exceptions = false
25
+
26
+ # Disable request forgery protection in test environment.
27
+ config.action_controller.allow_forgery_protection = false
28
+
29
+ # Tell Action Mailer not to deliver emails to the real world.
30
+ # The :test delivery method accumulates sent emails in the
31
+ # ActionMailer::Base.deliveries array.
32
+ config.action_mailer.delivery_method = :test
33
+
34
+ # Print deprecation notices to the stderr.
35
+ config.active_support.deprecation = :stderr
36
+ end
@@ -0,0 +1,7 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
4
+ # Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
5
+
6
+ # You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
7
+ # Rails.backtrace_cleaner.remove_silencers!
@@ -0,0 +1,4 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Configure sensitive parameters which will be filtered from the log file.
4
+ Rails.application.config.filter_parameters += [:password]
@@ -0,0 +1,16 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Add new inflection rules using the following format. Inflections
4
+ # are locale specific, and you may define rules for as many different
5
+ # locales as you wish. All of these examples are active by default:
6
+ # ActiveSupport::Inflector.inflections(:en) do |inflect|
7
+ # inflect.plural /^(ox)$/i, '\1en'
8
+ # inflect.singular /^(ox)en/i, '\1'
9
+ # inflect.irregular 'person', 'people'
10
+ # inflect.uncountable %w( fish sheep )
11
+ # end
12
+
13
+ # These inflection rules are supported but not enabled by default:
14
+ # ActiveSupport::Inflector.inflections(:en) do |inflect|
15
+ # inflect.acronym 'RESTful'
16
+ # end
@@ -0,0 +1,5 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Add new mime types for use in respond_to blocks:
4
+ # Mime::Type.register "text/richtext", :rtf
5
+ # Mime::Type.register_alias "text/html", :iphone
@@ -0,0 +1,12 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # Your secret key is used for verifying the integrity of signed cookies.
4
+ # If you change this key, all old signed cookies will become invalid!
5
+
6
+ # Make sure the secret is at least 30 characters and all random,
7
+ # no regular words or you'll be exposed to dictionary attacks.
8
+ # You can use `rake secret` to generate a secure secret key.
9
+
10
+ # Make sure your secret_key_base is kept private
11
+ # if you're sharing your code publicly.
12
+ Dummy::Application.config.secret_key_base = '06c32fa68a9ef1ff35278511d5d5955270551df5a4713c347e8f7184d5c05919be885704c4b345893080fb67fe5e4e66e06f98cb36bc3f86741ffda105030cdf'
@@ -0,0 +1,3 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ Dummy::Application.config.session_store :cookie_store, key: '_dummy_session'
@@ -0,0 +1,14 @@
1
+ # Be sure to restart your server when you modify this file.
2
+
3
+ # This file contains settings for ActionController::ParamsWrapper which
4
+ # is enabled by default.
5
+
6
+ # Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
7
+ ActiveSupport.on_load(:action_controller) do
8
+ wrap_parameters format: [:json] if respond_to?(:wrap_parameters)
9
+ end
10
+
11
+ # To enable root element in JSON for ActiveRecord objects.
12
+ # ActiveSupport.on_load(:active_record) do
13
+ # self.include_root_in_json = true
14
+ # end
@@ -0,0 +1,23 @@
1
+ # Files in the config/locales directory are used for internationalization
2
+ # and are automatically loaded by Rails. If you want to use locales other
3
+ # than English, add the necessary files in this directory.
4
+ #
5
+ # To use the locales, use `I18n.t`:
6
+ #
7
+ # I18n.t 'hello'
8
+ #
9
+ # In views, this is aliased to just `t`:
10
+ #
11
+ # <%= t('hello') %>
12
+ #
13
+ # To use a different locale, set it with `I18n.locale`:
14
+ #
15
+ # I18n.locale = :es
16
+ #
17
+ # This would use the information in config/locales/es.yml.
18
+ #
19
+ # To learn more, please read the Rails Internationalization guide
20
+ # available at http://guides.rubyonrails.org/i18n.html.
21
+
22
+ en:
23
+ hello: "Hello world"
@@ -0,0 +1,56 @@
1
+ Dummy::Application.routes.draw do
2
+ # The priority is based upon order of creation: first created -> highest priority.
3
+ # See how all your routes lay out with "rake routes".
4
+
5
+ # You can have the root of your site routed with "root"
6
+ # root 'welcome#index'
7
+
8
+ # Example of regular route:
9
+ # get 'products/:id' => 'catalog#view'
10
+
11
+ # Example of named route that can be invoked with purchase_url(id: product.id)
12
+ # get 'products/:id/purchase' => 'catalog#purchase', as: :purchase
13
+
14
+ # Example resource route (maps HTTP verbs to controller actions automatically):
15
+ # resources :products
16
+
17
+ # Example resource route with options:
18
+ # resources :products do
19
+ # member do
20
+ # get 'short'
21
+ # post 'toggle'
22
+ # end
23
+ #
24
+ # collection do
25
+ # get 'sold'
26
+ # end
27
+ # end
28
+
29
+ # Example resource route with sub-resources:
30
+ # resources :products do
31
+ # resources :comments, :sales
32
+ # resource :seller
33
+ # end
34
+
35
+ # Example resource route with more complex sub-resources:
36
+ # resources :products do
37
+ # resources :comments
38
+ # resources :sales do
39
+ # get 'recent', on: :collection
40
+ # end
41
+ # end
42
+
43
+ # Example resource route with concerns:
44
+ # concern :toggleable do
45
+ # post 'toggle'
46
+ # end
47
+ # resources :posts, concerns: :toggleable
48
+ # resources :photos, concerns: :toggleable
49
+
50
+ # Example resource route within a namespace:
51
+ # namespace :admin do
52
+ # # Directs /admin/products/* to Admin::ProductsController
53
+ # # (app/controllers/admin/products_controller.rb)
54
+ # resources :products
55
+ # end
56
+ end
File without changes
@@ -0,0 +1,58 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>The page you were looking for doesn't exist (404)</title>
5
+ <style>
6
+ body {
7
+ background-color: #EFEFEF;
8
+ color: #2E2F30;
9
+ text-align: center;
10
+ font-family: arial, sans-serif;
11
+ }
12
+
13
+ div.dialog {
14
+ width: 25em;
15
+ margin: 4em auto 0 auto;
16
+ border: 1px solid #CCC;
17
+ border-right-color: #999;
18
+ border-left-color: #999;
19
+ border-bottom-color: #BBB;
20
+ border-top: #B00100 solid 4px;
21
+ border-top-left-radius: 9px;
22
+ border-top-right-radius: 9px;
23
+ background-color: white;
24
+ padding: 7px 4em 0 4em;
25
+ }
26
+
27
+ h1 {
28
+ font-size: 100%;
29
+ color: #730E15;
30
+ line-height: 1.5em;
31
+ }
32
+
33
+ body > p {
34
+ width: 33em;
35
+ margin: 0 auto 1em;
36
+ padding: 1em 0;
37
+ background-color: #F7F7F7;
38
+ border: 1px solid #CCC;
39
+ border-right-color: #999;
40
+ border-bottom-color: #999;
41
+ border-bottom-left-radius: 4px;
42
+ border-bottom-right-radius: 4px;
43
+ border-top-color: #DADADA;
44
+ color: #666;
45
+ box-shadow:0 3px 8px rgba(50, 50, 50, 0.17);
46
+ }
47
+ </style>
48
+ </head>
49
+
50
+ <body>
51
+ <!-- This file lives in public/404.html -->
52
+ <div class="dialog">
53
+ <h1>The page you were looking for doesn't exist.</h1>
54
+ <p>You may have mistyped the address or the page may have moved.</p>
55
+ </div>
56
+ <p>If you are the application owner check the logs for more information.</p>
57
+ </body>
58
+ </html>
@@ -0,0 +1,58 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>The change you wanted was rejected (422)</title>
5
+ <style>
6
+ body {
7
+ background-color: #EFEFEF;
8
+ color: #2E2F30;
9
+ text-align: center;
10
+ font-family: arial, sans-serif;
11
+ }
12
+
13
+ div.dialog {
14
+ width: 25em;
15
+ margin: 4em auto 0 auto;
16
+ border: 1px solid #CCC;
17
+ border-right-color: #999;
18
+ border-left-color: #999;
19
+ border-bottom-color: #BBB;
20
+ border-top: #B00100 solid 4px;
21
+ border-top-left-radius: 9px;
22
+ border-top-right-radius: 9px;
23
+ background-color: white;
24
+ padding: 7px 4em 0 4em;
25
+ }
26
+
27
+ h1 {
28
+ font-size: 100%;
29
+ color: #730E15;
30
+ line-height: 1.5em;
31
+ }
32
+
33
+ body > p {
34
+ width: 33em;
35
+ margin: 0 auto 1em;
36
+ padding: 1em 0;
37
+ background-color: #F7F7F7;
38
+ border: 1px solid #CCC;
39
+ border-right-color: #999;
40
+ border-bottom-color: #999;
41
+ border-bottom-left-radius: 4px;
42
+ border-bottom-right-radius: 4px;
43
+ border-top-color: #DADADA;
44
+ color: #666;
45
+ box-shadow:0 3px 8px rgba(50, 50, 50, 0.17);
46
+ }
47
+ </style>
48
+ </head>
49
+
50
+ <body>
51
+ <!-- This file lives in public/422.html -->
52
+ <div class="dialog">
53
+ <h1>The change you wanted was rejected.</h1>
54
+ <p>Maybe you tried to change something you didn't have access to.</p>
55
+ </div>
56
+ <p>If you are the application owner check the logs for more information.</p>
57
+ </body>
58
+ </html>
@@ -0,0 +1,57 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>We're sorry, but something went wrong (500)</title>
5
+ <style>
6
+ body {
7
+ background-color: #EFEFEF;
8
+ color: #2E2F30;
9
+ text-align: center;
10
+ font-family: arial, sans-serif;
11
+ }
12
+
13
+ div.dialog {
14
+ width: 25em;
15
+ margin: 4em auto 0 auto;
16
+ border: 1px solid #CCC;
17
+ border-right-color: #999;
18
+ border-left-color: #999;
19
+ border-bottom-color: #BBB;
20
+ border-top: #B00100 solid 4px;
21
+ border-top-left-radius: 9px;
22
+ border-top-right-radius: 9px;
23
+ background-color: white;
24
+ padding: 7px 4em 0 4em;
25
+ }
26
+
27
+ h1 {
28
+ font-size: 100%;
29
+ color: #730E15;
30
+ line-height: 1.5em;
31
+ }
32
+
33
+ body > p {
34
+ width: 33em;
35
+ margin: 0 auto 1em;
36
+ padding: 1em 0;
37
+ background-color: #F7F7F7;
38
+ border: 1px solid #CCC;
39
+ border-right-color: #999;
40
+ border-bottom-color: #999;
41
+ border-bottom-left-radius: 4px;
42
+ border-bottom-right-radius: 4px;
43
+ border-top-color: #DADADA;
44
+ color: #666;
45
+ box-shadow:0 3px 8px rgba(50, 50, 50, 0.17);
46
+ }
47
+ </style>
48
+ </head>
49
+
50
+ <body>
51
+ <!-- This file lives in public/500.html -->
52
+ <div class="dialog">
53
+ <h1>We're sorry, but something went wrong.</h1>
54
+ </div>
55
+ <p>If you are the application owner check the logs for more information.</p>
56
+ </body>
57
+ </html>
File without changes
@@ -0,0 +1,66 @@
1
+ require 'spec_helper'
2
+
3
+ module ShortCircuit
4
+ describe Presentable do
5
+ before do
6
+ mock_model('TestModel')
7
+ TestModel.any_instance.stub(:test_method).and_return('Test Method')
8
+ TestModel.send(:include, Presentable)
9
+ stub_const('TestModelPresenter', Presenter)
10
+ end
11
+
12
+ let(:model) { TestModel.new }
13
+
14
+ describe '#presenter' do
15
+ subject(:presenter) { model.presenter }
16
+
17
+ it 'returns the correct presenter' do
18
+ expect(presenter).to be_a(Presenter)
19
+ expect(presenter).to be_a(TestModelPresenter)
20
+ end
21
+ end
22
+
23
+ describe '#present' do
24
+ context 'when the method exists' do
25
+ let(:method) { :test_method }
26
+
27
+ it 'calls the presenter method' do
28
+ expect(model.presenter).to receive(:send)
29
+ model.present(method)
30
+ end
31
+ end
32
+
33
+ context 'when the method does not exist' do
34
+ let(:method) { :fake_method }
35
+
36
+ it 'does not throw an error' do
37
+ expect { model.present(method) }.to_not raise_error
38
+ end
39
+
40
+ it 'calls the error_response method' do
41
+ expect(model.presenter).to receive(:error_response)
42
+ model.present(method)
43
+ end
44
+ end
45
+ end
46
+
47
+ describe '#present!' do
48
+ context 'when the method exists' do
49
+ let(:method) { :test_method }
50
+
51
+ it 'calls the presenter method' do
52
+ expect(model.presenter).to receive(:send)
53
+ model.present!(method)
54
+ end
55
+ end
56
+
57
+ context 'when the method does not exist' do
58
+ let(:method) { :fake_method }
59
+
60
+ it 'throws an error' do
61
+ expect { model.present!(method) }.to raise_error
62
+ end
63
+ end
64
+ end
65
+ end
66
+ end
@@ -0,0 +1,56 @@
1
+ require 'spec_helper'
2
+
3
+ module ShortCircuit
4
+ describe Presenter do
5
+ let(:presentable_object) do
6
+ mock_model('TestModel', test_method: 'Test Method')
7
+ end
8
+
9
+ let(:presenter) { Presenter.new(presentable_object) }
10
+
11
+ it 'delegates missing method calls to controller helpers' do
12
+ expect(ApplicationController.helpers).to receive(:fake_method)
13
+ presenter.send(:fake_method)
14
+ end
15
+
16
+ it 'delegates missing method calls to url helpers' do
17
+ expect(presenter.url_helpers).to receive(:fake_method)
18
+ presenter.send(:fake_method)
19
+ end
20
+
21
+ it 'delegates missing method calls to presentable object' do
22
+ expect(presenter.__getobj__).to receive(:fake_method)
23
+ presenter.send(:fake_method)
24
+
25
+ expect(presenter.test_method).to eq(presentable_object.test_method)
26
+ end
27
+
28
+ describe '#initialize' do
29
+ it 'sets presentable_object' do
30
+ expect(presenter.__getobj__).to eq(presentable_object)
31
+ end
32
+
33
+ it 'set an instance variable for presentable_object' do
34
+ var = "@#{presentable_object.class.to_s.underscore}"
35
+ expect(presenter.instance_variable_get(var)).to eq(presentable_object)
36
+ end
37
+ end
38
+
39
+ describe '#url_helpers' do
40
+ subject(:url_helpers) { presenter.url_helpers }
41
+
42
+ it 'returns url_helpers' do
43
+ expect(url_helpers).to_not be_nil
44
+ expect(url_helpers).to respond_to(:url_for)
45
+ end
46
+ end
47
+
48
+ describe '#error_response' do
49
+ subject(:error_response) { presenter.error_response('error', :method) }
50
+
51
+ it 'returns a blank response' do
52
+ expect(error_response).to be_empty
53
+ end
54
+ end
55
+ end
56
+ end
@@ -0,0 +1,19 @@
1
+ require 'coveralls'
2
+ Coveralls.wear!
3
+
4
+ ENV['RAILS_ENV'] ||= 'test'
5
+
6
+ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
7
+ $LOAD_PATH.unshift(File.dirname(__FILE__))
8
+
9
+ require File.expand_path('../dummy/config/environment', __FILE__)
10
+
11
+ require 'rails/all'
12
+ require 'rspec/rails'
13
+ require 'bundler/setup'
14
+
15
+ Bundler.require
16
+
17
+ RSpec.configure do |config|
18
+ config.color = true
19
+ end
metadata ADDED
@@ -0,0 +1,148 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: short_circuit-cj
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Jim Pruetting
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2014-08-05 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: rspec-rails
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - '>='
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - '>='
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: sqlite3
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - '>='
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - '>='
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ description: Short Circuit adds simple presenters for Rails views.
42
+ email:
43
+ - jim@roboticmethod.com}
44
+ executables: []
45
+ extensions: []
46
+ extra_rdoc_files: []
47
+ files:
48
+ - lib/short_circuit.rb
49
+ - lib/short_circuit/presentable.rb
50
+ - lib/short_circuit/version.rb
51
+ - lib/short_circuit/presenter.rb
52
+ - MIT-LICENSE
53
+ - README.md
54
+ - spec/short_circuit/presentable_spec.rb
55
+ - spec/short_circuit/presenter_spec.rb
56
+ - spec/spec_helper.rb
57
+ - spec/dummy/config/application.rb
58
+ - spec/dummy/config/initializers/backtrace_silencers.rb
59
+ - spec/dummy/config/initializers/filter_parameter_logging.rb
60
+ - spec/dummy/config/initializers/session_store.rb
61
+ - spec/dummy/config/initializers/wrap_parameters.rb
62
+ - spec/dummy/config/initializers/secret_token.rb
63
+ - spec/dummy/config/initializers/mime_types.rb
64
+ - spec/dummy/config/initializers/inflections.rb
65
+ - spec/dummy/config/locales/en.yml
66
+ - spec/dummy/config/environment.rb
67
+ - spec/dummy/config/routes.rb
68
+ - spec/dummy/config/boot.rb
69
+ - spec/dummy/config/environments/test.rb
70
+ - spec/dummy/config/environments/production.rb
71
+ - spec/dummy/config/environments/development.rb
72
+ - spec/dummy/config/database.yml
73
+ - spec/dummy/bin/rails
74
+ - spec/dummy/bin/rake
75
+ - spec/dummy/bin/bundle
76
+ - spec/dummy/app/views/layouts/application.html.erb
77
+ - spec/dummy/app/controllers/application_controller.rb
78
+ - spec/dummy/app/assets/stylesheets/application.css
79
+ - spec/dummy/app/assets/javascripts/application.js
80
+ - spec/dummy/app/helpers/application_helper.rb
81
+ - spec/dummy/config.ru
82
+ - spec/dummy/Rakefile
83
+ - spec/dummy/db/test.sqlite3
84
+ - spec/dummy/public/422.html
85
+ - spec/dummy/public/500.html
86
+ - spec/dummy/public/404.html
87
+ - spec/dummy/public/favicon.ico
88
+ - spec/dummy/README.rdoc
89
+ homepage: https://github.com/jpruetting/short_circuit
90
+ licenses: []
91
+ metadata: {}
92
+ post_install_message:
93
+ rdoc_options: []
94
+ require_paths:
95
+ - lib
96
+ required_ruby_version: !ruby/object:Gem::Requirement
97
+ requirements:
98
+ - - '>='
99
+ - !ruby/object:Gem::Version
100
+ version: '0'
101
+ required_rubygems_version: !ruby/object:Gem::Requirement
102
+ requirements:
103
+ - - '>='
104
+ - !ruby/object:Gem::Version
105
+ version: '0'
106
+ requirements: []
107
+ rubyforge_project:
108
+ rubygems_version: 2.0.14
109
+ signing_key:
110
+ specification_version: 4
111
+ summary: Simple presenters for Rails.
112
+ test_files:
113
+ - spec/short_circuit/presentable_spec.rb
114
+ - spec/short_circuit/presenter_spec.rb
115
+ - spec/spec_helper.rb
116
+ - spec/dummy/config/application.rb
117
+ - spec/dummy/config/initializers/backtrace_silencers.rb
118
+ - spec/dummy/config/initializers/filter_parameter_logging.rb
119
+ - spec/dummy/config/initializers/session_store.rb
120
+ - spec/dummy/config/initializers/wrap_parameters.rb
121
+ - spec/dummy/config/initializers/secret_token.rb
122
+ - spec/dummy/config/initializers/mime_types.rb
123
+ - spec/dummy/config/initializers/inflections.rb
124
+ - spec/dummy/config/locales/en.yml
125
+ - spec/dummy/config/environment.rb
126
+ - spec/dummy/config/routes.rb
127
+ - spec/dummy/config/boot.rb
128
+ - spec/dummy/config/environments/test.rb
129
+ - spec/dummy/config/environments/production.rb
130
+ - spec/dummy/config/environments/development.rb
131
+ - spec/dummy/config/database.yml
132
+ - spec/dummy/bin/rails
133
+ - spec/dummy/bin/rake
134
+ - spec/dummy/bin/bundle
135
+ - spec/dummy/app/views/layouts/application.html.erb
136
+ - spec/dummy/app/controllers/application_controller.rb
137
+ - spec/dummy/app/assets/stylesheets/application.css
138
+ - spec/dummy/app/assets/javascripts/application.js
139
+ - spec/dummy/app/helpers/application_helper.rb
140
+ - spec/dummy/config.ru
141
+ - spec/dummy/Rakefile
142
+ - spec/dummy/db/test.sqlite3
143
+ - spec/dummy/public/422.html
144
+ - spec/dummy/public/500.html
145
+ - spec/dummy/public/404.html
146
+ - spec/dummy/public/favicon.ico
147
+ - spec/dummy/README.rdoc
148
+ has_rdoc: