decent_exposure 3.0.0.beta2 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7cfd8c745c922accdd68b09011ac06094d2c71bc
-  data.tar.gz: 3eab645e6e2b13e763cbe6835125ec8104730c9d
+SHA256:
+  metadata.gz: 7f14b1fe6ed0c7cfea5f043262895e4f17bbd9cdd8f019259d8d0a44fb1f9f98
+  data.tar.gz: b5e0989425e1f94847b6867c4a0e81bd87d07a9fcd2683c9d64412700f7fd0d9
 SHA512:
-  metadata.gz: 7413bd28015045c87343f8bcc3210a46964420782f96c016fb2687c8f07a4ce26cdeb5868f35b9c376934593f36973fcfca2d1955bba40cd3b6e5ee4864bd67a
-  data.tar.gz: 92bb65c55c3c2f5902b93cb24ab54dadaf52b844360f377d49736df2b261e949f7130b551d9ad4b719625013ffe7398435efddbf00bd31aaaf35659d34f70120
+  metadata.gz: 705363f8c4b0fe230b6a25b3e171e74f936d1d1bc34af6a10b809d8283324c2b7a249e00d5455f5c2cec28944cf3aee94f0c2487b1c45f2b99a8ba0e60e732a8
+  data.tar.gz: d784e10c482a0a9e35c4aa21cf51632d6d0d28c0055f1f0b302259505c8b4f2d7feac9208af402a02a799ffca444c81d89f52ed278ef380096f1e6b45b30100c

data/.travis.yml

@@ -4,7 +4,7 @@ rvm:
   - 2.3.0
 gemfile:
   - Gemfile
-  - gemfiles/Gemfile.rails-5.0.0.rc1
+  - gemfiles/Gemfile.rails-5.0.0
   - gemfiles/Gemfile.rails-4.2.6
   - gemfiles/Gemfile.rails-4.2.0
 notifications:

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,5 +1,5 @@
 source "https://rubygems.org"
 
-gem 'rake'
+gem "rake"
 
 gemspec

data/README.md

@@ -18,7 +18,7 @@ Version `3.0` will support Rails 4 and 5.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'decent_exposure', '3.0.0.beta1'
+gem 'decent_exposure', '3.0.0'
 ```
 
 And then execute:
@@ -45,7 +45,7 @@ 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
@@ -309,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) }
 ```
 
@@ -325,6 +326,29 @@ 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:
@@ -333,7 +357,18 @@ If you want to generate rails scaffold templates prepared for `decent_exposure`
 rails generate decent_exposure:scaffold_templates [--template_engine erb|haml]
 ```
 
-This will create the templates in your `lib/templates` folder. Now you can run scaffold like:
+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
@@ -349,6 +384,6 @@ rails generate scaffold post title description:text
 
 ## 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,28 +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 "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 "standard"
 end

data/gemfiles/{Gemfile.rails-5.0.0.rc1 → Gemfile.rails-5.0.0}

@@ -2,4 +2,4 @@ source "https://rubygems.org"
 
 gemspec path: ".."
 
-gem "rails", "5.0.0.rc1"
+gem "rails", "5.0.0"

data/lib/decent_exposure.rb

@@ -4,13 +4,19 @@ 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

data/lib/decent_exposure/flow.rb

@@ -42,11 +42,11 @@ module DecentExposure
     delegate :params, to: :controller
 
     def get_request?
-      controller.request.get?
+      controller.request.get? || controller.request.head?
     end
 
     def params_method_name
-      options.fetch(:build_params_method){ "#{name}_params" }
+      options.fetch(:build_params_method) { "#{name}_params" }
     end
 
     def handle_flow_method(name, *args, &block)
@@ -75,7 +75,6 @@ module DecentExposure
       method.bind(self).call(*args, &block)
     end
 
-
     def fetch_ivar(name)
       ivar_name = "@#{name}"
 

data/lib/decent_exposure/mailer.rb

@@ -0,0 +1,15 @@
+module DecentExposure
+  module Mailer
+    def self.included(base)
+      base.class_eval do
+        attr_accessor :params
+
+        def process_action(*args)
+          arg = args.second
+          self.params = arg.stringify_keys if arg && Hash === arg
+          super
+        end
+      end
+    end
+  end
+end

data/lib/decent_exposure/version.rb

@@ -1,3 +1,3 @@
 module DecentExposure
-  VERSION = "3.0.0.beta2"
+  VERSION = "3.0.4"
 end

data/lib/generators/decent_exposure/scaffold_templates_generator.rb

@@ -1,14 +1,14 @@
-require 'rails/generators'
+require "rails/generators"
 
 module DecentExposure
   module Generators
     class ScaffoldTemplatesGenerator < Rails::Generators::Base
-      desc 'Generate DecentExposure scaffold template files'
-      source_root File.expand_path('../templates', __FILE__)
-      class_option :template_engine, desc: 'Template engine to be invoked (erb).'
+      desc "Generate DecentExposure scaffold template files"
+      source_root File.expand_path("../templates", __FILE__)
+      class_option :template_engine, desc: "Template engine to be invoked (erb)."
 
-      VIEWS = %i(_form edit index new show)
-      AVAILABLE_ENGINES = %w(erb haml)
+      VIEWS = %i[_form edit index new show]
+      AVAILABLE_ENGINES = %w[erb haml]
 
       def generate
         validate_template_engine
@@ -20,7 +20,7 @@ module DecentExposure
       private
 
       def generate_controller
-        copy_template('rails/scaffold_controller', 'controller.rb')
+        copy_template("rails/scaffold_controller", "controller.rb")
       end
 
       def generate_view(view)

data/spec/{controller_spec.rb → decent_exposure/controller_spec.rb}

@@ -1,11 +1,12 @@
 require "spec_helper"
 
-describe DecentExposure::Controller do
+RSpec.describe DecentExposure::Controller do
   class Thing; end
   class DifferentThing; end
 
   class BaseController
-    def self.helper_method(*); end
+    def self.helper_method(*)
+    end
 
     def params
       @params ||= HashWithIndifferentAccess.new
@@ -18,18 +19,18 @@ describe DecentExposure::Controller do
     end
   end
 
-  let(:request){ double("Request") }
-  let(:controller){ controller_klass.new }
-  before{ allow(controller).to receive(:request){ request } }
+  let(:request) { double("Request") }
+  let(:controller) { controller_klass.new }
+  before { allow(controller).to receive(:request) { request } }
 
   %w[expose expose! exposure_config].each do |method_name|
-    define_method method_name do |*args, &block|
-      controller_klass.send method_name, *args, &block
+    define_method method_name do |*args, **options, &block|
+      controller_klass.send method_name, *args, **options, &block
     end
   end
 
   context "getter/setter methods" do
-    before{ expose :thing }
+    before { expose :thing }
 
     it "defines getter method" do
       expect(controller).to respond_to(:thing)
@@ -41,8 +42,13 @@ describe DecentExposure::Controller do
   end
 
   context "helper methods" do
-    it "exposes getter and setter as controller helper methods" do
-      expect(controller_klass).to receive(:helper_method).with(:thing, :thing=)
+    it "exposes getter as controller helper methods" do
+      expect(controller_klass).to receive(:helper_method).with(:thing)
+      expose :thing
+    end
+
+    it "does not expose setter as controller helper methods" do
+      expect(controller_klass).to_not receive(:helper_method).with(:thing=)
       expose :thing
     end
   end
@@ -65,7 +71,7 @@ describe DecentExposure::Controller do
     end
 
     context "applying" do
-      let(:thing){ double("Thing") }
+      let(:thing) { double("Thing") }
 
       before do
         exposure_config :sluggable, find_by: :slug
@@ -75,7 +81,7 @@ describe DecentExposure::Controller do
         controller.params.merge! check_this_out: "foo", whee: "wut"
       end
 
-      after{ expect(controller.thing).to eq(thing) }
+      after { expect(controller.thing).to eq(thing) }
 
       it "can be reused later" do
         expose :thing, with: :weird_id_name
@@ -105,7 +111,7 @@ describe DecentExposure::Controller do
   end
 
   context "with block" do
-    before{ expose(:thing){ compute_thing } }
+    before { expose(:thing) { compute_thing } }
 
     it "executes block to calculate the value" do
       allow(controller).to receive(:compute_thing).and_return(42)
@@ -114,7 +120,7 @@ describe DecentExposure::Controller do
 
     it "executes the block once and memoizes the result" do
       expect(controller).to receive(:compute_thing).once.and_return(42)
-      10.times{ controller.thing }
+      10.times { controller.thing }
     end
 
     it "allows setting value directly" do
@@ -124,20 +130,20 @@ describe DecentExposure::Controller do
     end
 
     it "throws and error when providing options with block" do
-      action = ->{ expose(:thing, id: :some_id){ some_code } }
+      action = -> { expose(:thing, id: :some_id) { some_code } }
       expect(&action).to raise_error(ArgumentError, "Using :fetch option with other options doesn't make sense")
     end
   end
 
   context "passing fetch block as an argument instead of block" do
     it "is equivalent to passing block" do
-      expose :thing, ->{ compute_thing }
+      expose :thing, -> { compute_thing }
       expect(controller).to receive(:compute_thing).and_return(42)
       expect(controller.thing).to eq(42)
     end
 
     it "throws an error when passing both block and block-argument" do
-      action = ->{ expose(:thing, ->{}){} }
+      action = -> { expose(:thing, -> {}) {} }
       expect(&action).to raise_error(ArgumentError, "Fetch block is already defined")
     end
   end
@@ -152,7 +158,7 @@ describe DecentExposure::Controller do
 
   context "redefine fetch" do
     before do
-      expose :thing, fetch: ->{ compute_thing }
+      expose :thing, fetch: -> { compute_thing }
       allow(controller).to receive(:compute_thing).and_return(42)
     end
 
@@ -163,9 +169,9 @@ describe DecentExposure::Controller do
 
   context "default behaviour" do
     context "build" do
-      let(:thing){ double("Thing") }
+      let(:thing) { double("Thing") }
 
-      after{ expect(controller.thing).to eq(thing) }
+      after { expect(controller.thing).to eq(thing) }
 
       context "params method is not available" do
         it "builds a new instance with empty hash" do
@@ -184,20 +190,20 @@ describe DecentExposure::Controller do
 
         it "uses params method on non-get request" do
           expose :thing
-          expect(request).to receive(:get?).and_return(false)
+          expect(request).to receive_messages(get?: false, head?: false)
           expect(Thing).to receive(:new).with(foo: :bar).and_return(thing)
           expect(controller).to receive(:thing_params).and_return(foo: :bar)
         end
 
         it "can use custom params method name" do
           expose :thing, build_params: :custom_params_method_name
-          expect(request).to receive(:get?).and_return(false)
+          expect(request).to receive_messages(get?: false, head?: false)
           expect(Thing).to receive(:new).with(foo: :bar).and_return(thing)
           expect(controller).to receive(:custom_params_method_name).and_return(foo: :bar)
         end
 
         it "can use custom build params" do
-          expose :thing, build_params: ->{ foobar }
+          expose :thing, build_params: -> { foobar }
           expect(controller).to receive(:foobar).and_return(42)
           expect(Thing).to receive(:new).with(42).and_return(thing)
         end
@@ -210,7 +216,7 @@ describe DecentExposure::Controller do
         expect(DifferentThing).to receive(:find).with(10)
       end
 
-      after{ controller.thing }
+      after { controller.thing }
 
       it "checks params[:different_thing_id] first" do
         controller.params.merge! different_thing_id: 10, thing_id: 11, id: 12
@@ -227,14 +233,14 @@ describe DecentExposure::Controller do
 
   context "find_by" do
     it "throws and error when using with :find" do
-      action = ->{ expose :thing, find: :foo, find_by: :bar }
+      action = -> { expose :thing, find: :foo, find_by: :bar }
       expect(&action).to raise_error(ArgumentError, "Using :find_by option with :find doesn't make sense")
     end
 
     it "allows to specify what attribute to use for find" do
       expect(Thing).to receive(:find_by!).with(foo: 10).and_return(42)
       expose :thing, find_by: :foo
-      controller.params.merge! id: 10
+      controller.params[:id] = 10
       expect(controller.thing).to eq(42)
     end
   end
@@ -242,19 +248,19 @@ describe DecentExposure::Controller do
   context "parent option" do
     context "with scope/model options" do
       it "throws an error when used with scope option" do
-        action = ->{ expose :thing, scope: :foo, parent: :something }
+        action = -> { expose :thing, scope: :foo, parent: :something }
         expect(&action).to raise_error(ArgumentError, "Using :parent option with :scope doesn't make sense")
       end
 
       it "throws an error when used with model option" do
-        action = ->{ expose :thing, model: :foo, parent: :something }
+        action = -> { expose :thing, model: :foo, parent: :something }
         expect(&action).to raise_error(ArgumentError, "Using :parent option with :model doesn't make sense")
       end
     end
 
     context "build/find" do
-      let(:current_user){ double("User") }
-      let(:scope){ double("Scope") }
+      let(:current_user) { double("User") }
+      let(:scope) { double("Scope") }
 
       before do
         expect(controller).to receive(:current_user).and_return(current_user)
@@ -262,26 +268,26 @@ describe DecentExposure::Controller do
         expose :thing, parent: :current_user
       end
 
-      after{ expect(controller.thing).to eq(42) }
+      after { expect(controller.thing).to eq(42) }
 
       it "sets the scope to belong to parent defined by controller method" do
         expect(scope).to receive(:new).with({}).and_return(42)
       end
 
       it "scopes the find to proper scope" do
-        controller.params.merge! thing_id: 10
+        controller.params[:thing_id] = 10
         expect(scope).to receive(:find).with(10).and_return(42)
       end
     end
   end
 
   context "override model" do
-    let(:different_thing){ double("DifferentThing") }
-    before{ expect(DifferentThing).to receive(:new).with({}).and_return(different_thing) }
-    after{ expect(controller.thing).to eq(different_thing) }
+    let(:different_thing) { double("DifferentThing") }
+    before { expect(DifferentThing).to receive(:new).with({}).and_return(different_thing) }
+    after { expect(controller.thing).to eq(different_thing) }
 
     it "allows overriding model class with proc" do
-      expose :thing, model: ->{ DifferentThing }
+      expose :thing, model: -> { DifferentThing }
     end
 
     it "allows overriding model with class" do
@@ -300,7 +306,7 @@ describe DecentExposure::Controller do
   context "override scope" do
     it "allows overriding scope with proc" do
       scope = double("Scope")
-      expose :thing, scope: ->{ scope }
+      expose :thing, scope: -> { scope }
       expect(scope).to receive(:new).and_return(42)
       expect(controller.thing).to eq(42)
     end
@@ -321,7 +327,7 @@ describe DecentExposure::Controller do
     end
 
     it "allows overriding id with proc" do
-      expose :thing, id: ->{ get_thing_id_somehow }
+      expose :thing, id: -> { get_thing_id_somehow }
       expect(controller).to receive(:get_thing_id_somehow).and_return(42)
     end
 
@@ -338,7 +344,7 @@ describe DecentExposure::Controller do
 
   context "override decorator" do
     it "allows specify decorator" do
-      expose :thing, decorate: ->(thing){ decorate(thing) }
+      expose :thing, decorate: ->(thing) { decorate(thing) }
       thing = double("Thing")
       expect(Thing).to receive(:new).with({}).and_return(thing)
       expect(controller).to receive(:decorate).with(thing)
@@ -357,7 +363,7 @@ describe DecentExposure::Controller do
     end
 
     it "should throw error when used with other options" do
-      action = ->{ expose :thing, from: :foo, parent: :bar }
+      action = -> { expose :thing, from: :foo, parent: :bar }
       expect(&action).to raise_error(ArgumentError, "Using :from option with other options doesn't make sense")
     end
 
@@ -367,7 +373,7 @@ describe DecentExposure::Controller do
       foo = double("Foo", thing: thing)
       expect(controller).to receive(:foo).and_return(foo)
       expect(controller).to receive(:decorate).with(thing).and_return(decorated_thing)
-      expose :thing, from: :foo, decorate: ->(thing){ decorate(thing) }
+      expose :thing, from: :foo, decorate: ->(thing) { decorate(thing) }
       expect(controller.thing).to eq(decorated_thing)
     end
   end

data/spec/features/api_birds_controller_spec.rb

@@ -0,0 +1,70 @@
+require "spec_helper"
+require "support/rails_app"
+require "rspec/rails"
+
+RSpec.describe Api::BirdsController, type: :controller do
+  let(:bird) { Bird.new }
+
+  context "when birds relation is exposed" do
+    class Api::BirdsController
+      expose :birds, -> { Bird.all }
+    end
+
+    it "fetches all birds" do
+      expect(Bird).to receive(:all).and_return([bird])
+      get :index
+      expect(controller.birds).to eq([bird])
+    end
+  end
+
+  context "when a bird is exposed" do
+    class Api::BirdsController
+      expose :bird
+    end
+
+    it "finds model by id" do
+      expect(Bird).to receive(:find).with("bird-id").and_return(bird)
+      get :show, **request_params(id: "bird-id")
+      expect(controller.bird).to eq(bird)
+    end
+
+    it "finds model by bird_id" do
+      expect(Bird).to receive(:find).with("bird-id").and_return(bird)
+      get :new, **request_params(bird_id: "bird-id")
+      expect(controller.bird).to eq(bird)
+    end
+
+    it "builds bird if id is not provided" do
+      get :new
+      expect(controller.bird).to be_a(Bird)
+    end
+  end
+
+  context "when bird_params is defined" do
+    class Api::BirdsController
+      expose :bird
+
+      def bird_params
+        params.require(:bird).permit(:name)
+      end
+    end
+
+    it "bird is build with params set" do
+      post :create, **request_params(bird: {name: "crow"})
+      expect(controller.bird.name).to eq("crow")
+    end
+  end
+
+  context "when a bird? with a question mark is exposed" do
+    class Api::BirdsController
+      expose :bird
+      expose :bird?, -> { bird.present? }
+    end
+
+    it "exposes bird?" do
+      expect(Bird).to receive(:find).with("bird-id").and_return(bird)
+      get :show, **request_params(id: "bird-id")
+      expect(controller.bird?).to be true
+    end
+  end
+end

data/spec/features/birds_controller_spec.rb

@@ -0,0 +1,77 @@
+require "spec_helper"
+require "support/rails_app"
+require "rspec/rails"
+
+RSpec.describe BirdsController, type: :controller do
+  let(:bird) { Bird.new }
+
+  context "when birds relation is exposed" do
+    class BirdsController
+      expose :birds, -> { Bird.all }
+    end
+
+    it "fetches all birds" do
+      expect(Bird).to receive(:all).and_return([bird])
+      get :index
+      expect(controller.birds).to eq([bird])
+    end
+  end
+
+  context "when a bird is exposed" do
+    class BirdsController
+      expose :bird
+    end
+
+    it "finds model by id" do
+      expect(Bird).to receive(:find).with("bird-id").and_return(bird)
+      get :show, **request_params(id: "bird-id")
+      expect(controller.bird).to eq(bird)
+    end
+
+    it "finds model by bird_id" do
+      expect(Bird).to receive(:find).with("bird-id").and_return(bird)
+      get :new, **request_params(bird_id: "bird-id")
+      expect(controller.bird).to eq(bird)
+    end
+
+    it "builds bird if id is not provided" do
+      get :new
+      expect(controller.bird).to be_a(Bird)
+    end
+
+    context "when request.method is HEAD" do
+      it "builds bird if id is not provided" do
+        head :new
+        expect(controller.bird).to be_a(Bird)
+      end
+    end
+  end
+
+  context "when bird_params is defined" do
+    class BirdsController
+      expose :bird
+
+      def bird_params
+        params.require(:bird).permit(:name)
+      end
+    end
+
+    it "bird is build with params set" do
+      post :create, **request_params(bird: {name: "crow"})
+      expect(controller.bird.name).to eq("crow")
+    end
+  end
+
+  context "when a bird? with a question mark is exposed" do
+    class BirdsController
+      expose :bird
+      expose :bird?, -> { bird.present? }
+    end
+
+    it "exposes bird?" do
+      expect(Bird).to receive(:find).with("bird-id").and_return(bird)
+      get :show, **request_params(id: "bird-id")
+      expect(controller.bird?).to be true
+    end
+  end
+end

data/spec/features/birds_mailer_spec.rb

@@ -0,0 +1,54 @@
+require "spec_helper"
+require "support/rails_app"
+require "rspec/rails"
+require "action_mailer"
+
+class BirdsMailer < ActionMailer::Base
+end
+
+class BirdsMailer
+  expose(:birds, -> { Bird.all })
+  expose(:bird)
+
+  def hello_birds
+    mail { |format| format.text { render plain: "Hello #{birds}" } }
+  end
+
+  def hello_bird(id:)
+    mail { |format| format.text { render plain: "Hello #{bird}" } }
+  end
+
+  def hello_bird_by_id(id)
+    bird = Bird.find(id)
+    mail { |format| format.text { render plain: "Hello #{bird}" } }
+  end
+end
+
+RSpec.describe BirdsMailer, type: :mailer do
+  let(:bird) { double :bird }
+  let(:birds) { double :birds }
+
+  context "when birds relation is exposed" do
+    it "sends the email with exposed birds" do
+      expect(Bird).to receive(:all).and_return(birds)
+      expect(described_class.hello_birds.body.to_s)
+        .to include("Hello #{birds}")
+    end
+  end
+
+  context "when bird is exposed" do
+    it "sends the email with exposed bird" do
+      expect(Bird).to receive(:find).with("some-id").and_return(bird)
+      expect(described_class.hello_bird(id: "some-id").body.to_s)
+        .to include("Hello #{bird}")
+    end
+  end
+
+  context "with non hash argument" do
+    it "does not set params" do
+      expect(Bird).to receive(:find).with("some-id").and_return(bird)
+      expect(described_class.hello_bird_by_id("some-id").body.to_s)
+        .to include("Hello #{bird}")
+    end
+  end
+end

data/spec/generators/decent_exposure/scaffold_templates_generator_spec.rb

@@ -1,45 +1,44 @@
-require 'spec_helper'
+require "spec_helper"
 
 RSpec.describe DecentExposure::Generators::ScaffoldTemplatesGenerator, type: :generator do
-
   subject(:generator) { described_class.new }
 
-  context 'with erb' do
-    it 'generates controller and erb views' do
-      allow(generator).to receive(:copy_file).with('controller.rb', 'lib/templates/rails/scaffold_controller/controller.rb')
-      allow(generator).to receive(:copy_file).with('_form.html.erb', 'lib/templates/erb/scaffold/_form.html.erb')
-      allow(generator).to receive(:copy_file).with('edit.html.erb', 'lib/templates/erb/scaffold/edit.html.erb')
-      allow(generator).to receive(:copy_file).with('index.html.erb', 'lib/templates/erb/scaffold/index.html.erb')
-      allow(generator).to receive(:copy_file).with('new.html.erb', 'lib/templates/erb/scaffold/new.html.erb')
-      allow(generator).to receive(:copy_file).with('show.html.erb', 'lib/templates/erb/scaffold/show.html.erb')
+  context "with erb" do
+    it "generates controller and erb views" do
+      allow(generator).to receive(:copy_file).with("controller.rb", "lib/templates/rails/scaffold_controller/controller.rb")
+      allow(generator).to receive(:copy_file).with("_form.html.erb", "lib/templates/erb/scaffold/_form.html.erb")
+      allow(generator).to receive(:copy_file).with("edit.html.erb", "lib/templates/erb/scaffold/edit.html.erb")
+      allow(generator).to receive(:copy_file).with("index.html.erb", "lib/templates/erb/scaffold/index.html.erb")
+      allow(generator).to receive(:copy_file).with("new.html.erb", "lib/templates/erb/scaffold/new.html.erb")
+      allow(generator).to receive(:copy_file).with("show.html.erb", "lib/templates/erb/scaffold/show.html.erb")
 
       generator.generate
     end
   end
 
-  context 'with haml' do
+  context "with haml" do
     before do
       allow(generator).to receive(:options).and_return(template_engine: :haml)
     end
 
-    it 'generates controller and haml views' do
-      allow(generator).to receive(:copy_file).with('controller.rb', 'lib/templates/rails/scaffold_controller/controller.rb')
-      allow(generator).to receive(:copy_file).with('_form.html.haml', 'lib/templates/haml/scaffold/_form.html.haml')
-      allow(generator).to receive(:copy_file).with('edit.html.haml', 'lib/templates/haml/scaffold/edit.html.haml')
-      allow(generator).to receive(:copy_file).with('index.html.haml', 'lib/templates/haml/scaffold/index.html.haml')
-      allow(generator).to receive(:copy_file).with('new.html.haml', 'lib/templates/haml/scaffold/new.html.haml')
-      allow(generator).to receive(:copy_file).with('show.html.haml', 'lib/templates/haml/scaffold/show.html.haml')
+    it "generates controller and haml views" do
+      allow(generator).to receive(:copy_file).with("controller.rb", "lib/templates/rails/scaffold_controller/controller.rb")
+      allow(generator).to receive(:copy_file).with("_form.html.haml", "lib/templates/haml/scaffold/_form.html.haml")
+      allow(generator).to receive(:copy_file).with("edit.html.haml", "lib/templates/haml/scaffold/edit.html.haml")
+      allow(generator).to receive(:copy_file).with("index.html.haml", "lib/templates/haml/scaffold/index.html.haml")
+      allow(generator).to receive(:copy_file).with("new.html.haml", "lib/templates/haml/scaffold/new.html.haml")
+      allow(generator).to receive(:copy_file).with("show.html.haml", "lib/templates/haml/scaffold/show.html.haml")
 
       generator.generate
     end
   end
 
-  context 'with invalid template_engine' do
+  context "with invalid template_engine" do
     before do
       allow(generator).to receive(:options).and_return(template_engine: :foo_bar)
     end
 
-    it 'raises an ArgumentError' do
+    it "raises an ArgumentError" do
       expect { generator.generate }. to raise_error(ArgumentError)
     end
   end

data/spec/support/rails_app.rb

@@ -1,37 +1,69 @@
-require "active_support/all"
 require "action_controller"
-require "action_dispatch"
 require "rails"
 
+def request_params(params)
+  return params if Rails::VERSION::MAJOR < 5
+  {params: params}
+end
+
 module Rails
   class App
-    def env_config; {} end
+    def env_config
+      {}
+    end
 
     def routes
       @routes ||= ActionDispatch::Routing::RouteSet.new.tap do |routes|
         routes.draw do
-          resource :birds
+          resources :birds
+
+          namespace :api do
+            resources :birds
+          end
         end
       end
     end
   end
 
+  def self.root
+    ""
+  end
+
   def self.application
     @app ||= App.new
   end
 end
 
 class Bird
+  attr_accessor :name
+  def initialize(options = {})
+    options.each { |k, v| public_send("#{k}=", v) }
+  end
 end
 
 class ApplicationController < ActionController::Base
   include Rails.application.routes.url_helpers
 end
 
+def base_api_class
+  return ApplicationController if Rails::VERSION::MAJOR < 5
+  ActionController::API
+end
+
 class BirdsController < ApplicationController
-  expose :bird
+  %i[index show edit new create update].each do |action|
+    define_method action do
+      head :ok
+    end
+  end
+end
 
-  def show
-    head :ok
+module Api
+  class BirdsController < base_api_class
+    %i[index show edit new create update].each do |action|
+      define_method action do
+        head :ok
+      end
+    end
   end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: decent_exposure
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta2
+  version: 3.0.4
 platform: ruby
 authors:
 - Pavel Pravosud
 - Stephen Caudill
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-05-11 00:00:00.000000000 Z
+date: 2021-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -39,6 +39,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -53,6 +67,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: "\n    DecentExposure helps you program to an interface, rather than
   an\n    implementation in your Rails controllers.  The fact of the matter is that\n
   \   sharing state via instance variables in controllers promotes close coupling\n
@@ -67,6 +95,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -75,8 +104,7 @@ files:
 - decent_exposure.png
 - gemfiles/Gemfile.rails-4.2.0
 - gemfiles/Gemfile.rails-4.2.6
-- gemfiles/Gemfile.rails-5.0.0.rc1
-- hashrocket_logo.png
+- gemfiles/Gemfile.rails-5.0.0
 - lib/decent_exposure.rb
 - lib/decent_exposure/attribute.rb
 - lib/decent_exposure/behavior.rb
@@ -84,6 +112,7 @@ files:
 - lib/decent_exposure/controller.rb
 - lib/decent_exposure/exposure.rb
 - lib/decent_exposure/flow.rb
+- lib/decent_exposure/mailer.rb
 - lib/decent_exposure/version.rb
 - lib/generators/decent_exposure/USAGE
 - lib/generators/decent_exposure/scaffold_templates_generator.rb
@@ -98,38 +127,41 @@ files:
 - lib/generators/decent_exposure/templates/new.html.haml
 - lib/generators/decent_exposure/templates/show.html.erb
 - lib/generators/decent_exposure/templates/show.html.haml
-- spec/controller_spec.rb
+- spec/decent_exposure/controller_spec.rb
+- spec/features/api_birds_controller_spec.rb
+- spec/features/birds_controller_spec.rb
+- spec/features/birds_mailer_spec.rb
 - spec/generators/decent_exposure/scaffold_templates_generator_spec.rb
-- spec/integration_spec.rb
 - spec/spec_helper.rb
 - spec/support/rails_app.rb
 homepage: https://github.com/hashrocket/decent_exposure
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.4
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: A helper for creating declarative interfaces in controllers
 test_files:
-- spec/controller_spec.rb
+- spec/decent_exposure/controller_spec.rb
+- spec/features/api_birds_controller_spec.rb
+- spec/features/birds_controller_spec.rb
+- spec/features/birds_mailer_spec.rb
 - spec/generators/decent_exposure/scaffold_templates_generator_spec.rb
-- spec/integration_spec.rb
 - spec/spec_helper.rb
 - spec/support/rails_app.rb

data/spec/integration_spec.rb

@@ -1,26 +0,0 @@
-require "spec_helper"
-require "support/rails_app"
-require "rspec/rails"
-
-describe BirdsController, type: :controller do
-  context "finds bird by id" do
-    let(:mockingbird){ double("Bird") }
-    before{ expect(Bird).to receive(:find).with("mockingbird").once.and_return(mockingbird) }
-    after{ expect(controller.bird).to eq(mockingbird) }
-
-    it "finds model by id" do
-      get :show, { id: "mockingbird" }
-    end
-
-    it "finds model by bird_id" do
-      get :show, { bird_id: "mockingbird" }
-    end
-  end
-
-  it "builds bird if id is not provided" do
-    bird = double("Bird")
-    expect(Bird).to receive(:new).with({}).and_return(bird)
-    get :show
-    expect(controller.bird).to eq(bird)
-  end
-end