decent_exposure 3.0.0.beta1 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2ec6d62cc52928970902ade2a9998e8f58758f7c
-  data.tar.gz: 0a3aff2440f88ed56a20197d270402c826c6b5e3
+SHA256:
+  metadata.gz: 3f21e1f9876dc8a5fb33726db86f7dd57c37f5c02d1947594e5d35378fa3c9fb
+  data.tar.gz: f3df28184866142fdcc357c815e035c4d12181d639cd815e9d2735cc268354d8
 SHA512:
-  metadata.gz: c085171f6369dda3d9ae3f459aed654dcdc5a0934f28b61b605ffa1cbff9951cc5b44b214179d3969764064c748c7cddac8dc58655c7972f09dcaa6c5bec0bff
-  data.tar.gz: 692f0b40e7d1435ebaec5ac4d96422b8cb69592afcb3b5010c597f71f65f7c3f88588ee26dffd17ae38cd83ad269f5fa1581030bbf132ea3c4a63a8b38d1bf81
+  metadata.gz: 340c2ad9f56e884653dc235063e43cf874a344cd01e6f8b5fb5301c993dec5a53f4328703a154c4ae1caeeffd39c5eaea5f4a79eb9976bc34f313530d1d6933a
+  data.tar.gz: e9d9363c1a34280c7084e1662c9428577f68d0617e31436e013f0f0e782067ecb42177849f0710cd8c49f03f2e94e4e09758771faeec5f1848a9fc02cd23eff5

data/.travis.yml

@@ -1,3 +1,15 @@
+language: ruby
 rvm:
   - 2.2.2
   - 2.3.0
+gemfile:
+  - Gemfile
+  - gemfiles/Gemfile.rails-5.0.0
+  - gemfiles/Gemfile.rails-4.2.6
+  - gemfiles/Gemfile.rails-4.2.0
+notifications:
+  slack:
+    on_success: change
+    on_failure: always
+    rooms:
+      secure: Ch/Euv0+g1BQawHLVXzT9R/eoFxQWBf95SQzufpA19tlwz+7OsGlaOH4YfxVbnanH33XL06AEB1arsDUwlv0lx/I2Cs1LRh4WHAJ7T5hahusF2W3/+RgCDf2eifk1MRswkDpvhxH/sAS6INc4gOKc52q4gAdzU2uytVsdaaCjCY=

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# DecentExposure History/Changelog
+
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## 3.0.2
+
+* Fix mailers when arguments are not a hash.
+
+## 3.0.1
+
+* Allow exposures with a question mark (?).
+* Remove setter from view helper.
+* Fix undefined `helper_method` error
+
+## 3.0.0
+
+* New codebase, see [api changes document](https://github.com/hashrocket/decent_exposure/wiki/Api-changes-in-version-3).
+

data/Gemfile

@@ -1,3 +1,5 @@
 source "https://rubygems.org"
 
+gem "rake"
+
 gemspec

data/README.md

@@ -7,16 +7,18 @@
 
 ### Notice
 
-DecentExposure `3.0` is a major change from `< 3.0`. If you are using `rails <= 4.2.x` please look at `decent_exposure < 3.0`.
+DecentExposure `3.0` is a major change from `< 3.0`.
 
-**Be aware... mild API changes ahead.**
+Version `3.0` will support Rails 4 and 5.
+
+**Be aware... mild API changes ahead.** Check this [API changes in version 3](https://github.com/hashrocket/decent_exposure/wiki/Api-changes-in-version-3)
 
 ### Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'decent_exposure'
+gem 'decent_exposure', '3.0.0'
 ```
 
 And then execute:
@@ -43,12 +45,12 @@ end
 
 Now every time you call `thing` in your controller or view, it will look for an
 ID and try to perform `Thing.find(id)`. If the ID isn't found, it will call
-`Thing.new(things_params)`. The result will be memoized in an `@exposed_thing`
+`Thing.new(thing_params)`. The result will be memoized in an `@exposed_thing`
 instance variable.
 
 #### Example Controller
 
-Here's what a standard Rails 4 CRUD controller using Decent Exposure might look like:
+Here's what a standard Rails 5 CRUD controller using Decent Exposure might look like:
 
 ```ruby
 class ThingsController < ApplicationController
@@ -307,6 +309,7 @@ decoration process. Initially, this does nothing, but you can obviously change
 that:
 
 ```ruby
+expose :things, ->{ Thing.all.map{ |thing| ThingDecorator.new(thing) } }
 expose :thing, decorate: ->(thing){ ThingDecorator.new(thing) }
 ```
 
@@ -323,6 +326,54 @@ expose :thing, with: [:cool_find, :cool_build]
 expose :another_thing, with: :cool_build
 ```
 
+## Rails Mailers
+
+Mailers and Controllers use the same decent_exposure dsl.
+
+### Example Mailer
+
+```ruby
+class PostMailer < ApplicationMailer
+  expose(:posts, -> { Post.last(10) })
+  expose(:post)
+
+  def top_posts
+    @greeting = "Top Posts"
+    mail to: "to@example.org"
+  end
+
+  def featured_post(id:)
+    @greeting = "Featured Post"
+    mail to: "to@example.org"
+  end
+end
+```
+
+## Rails Scaffold Templates
+
+If you want to generate rails scaffold templates prepared for `decent_exposure` run:
+
+```bash
+rails generate decent_exposure:scaffold_templates [--template_engine erb|haml]
+```
+
+This will create the templates in your `lib/templates` folder.
+
+Make sure you have configured your templates engine for generators in `config/application.rb`:
+
+```ruby
+# config/application.rb
+config.generators do |g|
+  g.template_engine :erb
+end
+```
+
+Now you can run scaffold like:
+
+```bash
+rails generate scaffold post title description:text
+```
+
 ## Contributing
 
 1. Fork it (https://github.com/hashrocket/decent_exposure/fork)
@@ -333,6 +384,6 @@ expose :another_thing, with: :cool_build
 
 ## About
 
-[![Hashrocket logo](hashrocket_logo.png)](https://hashrocket.com)
+[![Hashrocket logo](https://hashrocket.com/hashrocket_logo.svg)](https://hashrocket.com)
 
-Decent Exposure is supported by the team at [Hashrocket](https://hashrocket.com), a multidisciplinary design & development consultancy. If you'd like to [work with us](https://hashrocket.com/contact-us/hire-us) or [join our team](https://hashrocket.com/contact-us/jobs), don't hesitate to get in touch.
+Decent Exposure is supported by the team at [Hashrocket](https://hashrocket.com), a multidisciplinary design & development consultancy. If you'd like to [work with us](https://hashrocket.com/contact) or [join our team](https://hashrocket.com/careers), don't hesitate to get in touch.

data/decent_exposure.gemspec

@@ -1,30 +1,30 @@
 require File.expand_path("../lib/decent_exposure/version", __FILE__)
 
 Gem::Specification.new do |spec|
-  spec.name         = "decent_exposure"
-  spec.version      = DecentExposure::VERSION
-  spec.authors      = ["Pavel Pravosud", "Stephen Caudill"]
-  spec.email        = ["info@hashrocket.com"]
-  spec.summary      = "A helper for creating declarative interfaces in controllers"
-  spec.description = %q{
+  spec.name = "decent_exposure"
+  spec.version = DecentExposure::VERSION
+  spec.authors = ["Pavel Pravosud", "Stephen Caudill"]
+  spec.email = ["info@hashrocket.com"]
+  spec.summary = "A helper for creating declarative interfaces in controllers"
+  spec.description = '
     DecentExposure helps you program to an interface, rather than an
     implementation in your Rails controllers.  The fact of the matter is that
     sharing state via instance variables in controllers promotes close coupling
     with views.  DecentExposure gives you a declarative manner of exposing an
     interface to the state that controllers contain and thereby decreasing
     coupling and improving your testability and overall design.
-  }
-  spec.homepage     = "https://github.com/hashrocket/decent_exposure"
-  spec.license      = "MIT"
-  spec.files        = `git ls-files -z`.split("\x0")
-  spec.test_files   = spec.files.grep(/\Aspec\//)
+  '
+  spec.homepage = "https://github.com/hashrocket/decent_exposure"
+  spec.license = "MIT"
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.test_files = spec.files.grep(/\Aspec\//)
   spec.require_path = "lib"
 
-  spec.required_ruby_version = "~> 2.0"
+  spec.required_ruby_version = ">= 2.0"
 
-  spec.add_dependency "railties",      "~> 5.x"
-  spec.add_dependency "activesupport", "~> 5.x"
+  spec.add_dependency "activesupport", ">= 4.0"
+  spec.add_development_dependency "railties", ">= 4.0"
+  spec.add_development_dependency "actionmailer"
   spec.add_development_dependency "rspec-rails", "~> 3.0"
-  spec.add_development_dependency "rake", "~> 10.3"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency "standard"
 end

data/gemfiles/Gemfile.rails-4.2.0

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "rails", "4.2.0"

data/gemfiles/Gemfile.rails-4.2.6

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "rails", "4.2.6"

data/gemfiles/Gemfile.rails-5.0.0

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec path: ".."
+
+gem "rails", "5.0.0"

data/lib/decent_exposure.rb

@@ -1,15 +1,22 @@
 require "decent_exposure/version"
 require "active_support/all"
+require "generators/decent_exposure/scaffold_templates_generator"
 
 module DecentExposure
   autoload :Controller, "decent_exposure/controller"
-  autoload :Exposure,   "decent_exposure/exposure"
-  autoload :Attribute,  "decent_exposure/attribute"
-  autoload :Context,    "decent_exposure/context"
-  autoload :Behavior,   "decent_exposure/behavior"
-  autoload :Flow,       "decent_exposure/flow"
+  autoload :Mailer, "decent_exposure/mailer"
+  autoload :Exposure, "decent_exposure/exposure"
+  autoload :Attribute, "decent_exposure/attribute"
+  autoload :Context, "decent_exposure/context"
+  autoload :Behavior, "decent_exposure/behavior"
+  autoload :Flow, "decent_exposure/flow"
 
   ActiveSupport.on_load :action_controller do
     include Controller
   end
+
+  ActiveSupport.on_load :action_mailer do
+    include Controller
+    include Mailer
+  end
 end

data/lib/decent_exposure/attribute.rb

@@ -32,7 +32,6 @@ module DecentExposure
       "#{name}=".to_sym
     end
 
-
     # Public: Expose a getter and setter method for the Attribute
     # on the passed in Controller class.
     #

data/lib/decent_exposure/behavior.rb

@@ -86,7 +86,7 @@ module DecentExposure
     protected
 
     def params_id_key_candidates
-      [ "#{model_param_key}_id", "#{name}_id", "id" ].uniq
+      ["#{model_param_key}_id", "#{name}_id", "id"].uniq
     end
 
     def model_param_key

data/lib/decent_exposure/context.rb

@@ -20,7 +20,7 @@ module DecentExposure
     #
     # Returns the attribute's value.
     def get
-      ivar_defined?? ivar_get : set(fetch_value)
+      ivar_defined? ? ivar_get : set(fetch_value)
     end
 
     # Public: Write to an attribute on the context Class.
@@ -51,7 +51,7 @@ module DecentExposure
     end
 
     def ivar_name
-      "@#{attribute.ivar_name}"
+      "@#{attribute.ivar_name.gsub("?", "_question_mark_")}"
     end
 
     def fetch_value

data/lib/decent_exposure/controller.rb

@@ -17,8 +17,8 @@ module DecentExposure
       #
       # Returns the helper methods that are now defined on the class
       # where this method is included.
-      def expose(*args, &block)
-        Exposure.expose! self, *args, &block
+      def expose(*args, **options, &block)
+        Exposure.expose! self, *args, **options, &block
       end
 
       # Public: Exposes an attribute to a controller Class.
@@ -33,8 +33,8 @@ module DecentExposure
       #
       # Sets the exposed attribute to a before_action callback in the
       # controller.
-      def expose!(name, *args, &block)
-        expose name, *args, &block
+      def expose!(name, *args, **options, &block)
+        expose name, *args, **options, &block
         before_action name
       end
 

data/lib/decent_exposure/exposure.rb

@@ -13,8 +13,8 @@ module DecentExposure
     #          the Proc when called.
     #
     # Returns a collection of exposed helper methods.
-    def self.expose!(*args, &block)
-      new(*args, &block).expose!
+    def self.expose!(*args, **options, &block)
+      new(*args, **options, &block).expose!
     end
 
     # Public: Initalize an Exposure with a hash of options.
@@ -34,7 +34,7 @@ module DecentExposure
     #               the Proc.
     #
     # Returns a normalized options Hash.
-    def initialize(controller, name, fetch_block=nil, **options, &block)
+    def initialize(controller, name, fetch_block = nil, **options, &block)
       @controller = controller
       @options = options.with_indifferent_access.merge(name: name)
 
@@ -67,8 +67,9 @@ module DecentExposure
     end
 
     def expose_helper_methods!
-      helper_methods = [ attribute.getter_method_name, attribute.setter_method_name ]
-      controller.helper_method *helper_methods
+      return unless controller.respond_to?(:helper_method)
+
+      controller.helper_method attribute.getter_method_name
     end
 
     def normalize_options
@@ -85,43 +86,43 @@ module DecentExposure
 
     def normalize_fetch_option
       normalize_non_proc_option :fetch do |method_name|
-        ->{ send(method_name) }
+        -> { send(method_name) }
       end
     end
 
     def normalize_find_by_option
-      if find_by = options.delete(:find_by)
-        merge_lambda_option :find, ->(id, scope){ scope.find_by!(find_by => id) }
+      if (find_by = options.delete(:find_by))
+        merge_lambda_option :find, ->(id, scope) { scope.find_by!(find_by => id) }
       end
     end
 
     def normalize_parent_option
       exposure_name = options.fetch(:name)
 
-      if parent = options.delete(:parent)
-        merge_lambda_option :scope, ->{ send(parent).send(exposure_name.to_s.pluralize) }
+      if (parent = options.delete(:parent))
+        merge_lambda_option :scope, -> { send(parent).send(exposure_name.to_s.pluralize) }
       end
     end
 
     def normalize_from_option
       exposure_name = options.fetch(:name)
 
-      if from = options.delete(:from)
-        merge_lambda_option :build, ->{ send(from).send(exposure_name) }
-        merge_lambda_option :model, ->{ nil }
-        merge_lambda_option :id, ->{ nil }
+      if (from = options.delete(:from))
+        merge_lambda_option :build, -> { send(from).send(exposure_name) }
+        merge_lambda_option :model, -> { nil }
+        merge_lambda_option :id, -> { nil }
       end
     end
 
     def normalize_with_option
-      if configs = options.delete(:with)
-        Array.wrap(configs).each{ |config| reverse_merge_config! config }
+      if (configs = options.delete(:with))
+        Array.wrap(configs).each { |config| reverse_merge_config! config }
       end
     end
 
     def normalize_id_option
       normalize_non_proc_option :id do |ids|
-        ->{ Array.wrap(ids).map{ |id| params[id] }.find(&:present?) }
+        -> { Array.wrap(ids).map { |id| params[id] }.find(&:present?) }
       end
     end
 
@@ -133,7 +134,7 @@ module DecentExposure
           value
         end
 
-        ->{ model }
+        -> { model }
       end
     end
 
@@ -146,7 +147,7 @@ module DecentExposure
 
     def normalize_scope_options
       normalize_non_proc_option :scope do |custom_scope|
-        ->(model){ model.send(custom_scope) }
+        ->(model) { model.send(custom_scope) }
       end
     end
 
@@ -164,7 +165,7 @@ module DecentExposure
     end
 
     def merge_lambda_option(name, body)
-      if previous_value = options[name] and Proc === previous_value
+      if (previous_value = options[name]) && (Proc === previous_value)
         fail ArgumentError, "#{name.to_s.titleize} block is already defined"
       end
 
@@ -177,7 +178,7 @@ module DecentExposure
 
         name = options.fetch(:name)
         ivar_name = "exposed_#{name}"
-        fetch = ->{ Flow.new(self, local_options).fetch }
+        fetch = -> { Flow.new(self, local_options).fetch }
 
         Attribute.new(
           name: name,
@@ -188,13 +189,13 @@ module DecentExposure
     end
 
     def assert_incompatible_options_pair(key1, key2)
-      if options.key?(key1) && options.key?(key2)
+      if options.symbolize_keys.key?(key1) && options.symbolize_keys.key?(key2)
         fail ArgumentError, "Using #{key1.inspect} option with #{key2.inspect} doesn't make sense"
       end
     end
 
     def assert_singleton_option(name)
-      if options.except(name, :name, :decorate).any? && options.key?(name)
+      if options.symbolize_keys.except(name, :name, :decorate).any? && options.symbolize_keys.key?(name)
         fail ArgumentError, "Using #{name.inspect} option with other options doesn't make sense"
       end
     end