decent_exposure 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f8425a920206dc8af5e761d2f3f3783a7a7c6b4
-  data.tar.gz: b3f21e7fb044bf0b554cc26918d40ce84aa5b188
+  metadata.gz: 2c22278ff98a7439d7b4a8b1f6cde9f9a1dc9a9a
+  data.tar.gz: 7a781674c590dbf7d1d200895babf9633b49c733
 SHA512:
-  metadata.gz: fbe1b3c1f9806de47df1a8ce1700d9ab5908c1981bc92fd1f63e528f4d60896556e9c9ede8b73b1966a047916158aaa33a141a3451aa4577a4cadf9da092ee2f
-  data.tar.gz: f50003ad917244794fdd3a767d9e18dc3d40ab22914a60f8efb7d77639facdf09e02436647821df43a0157ff0bb4f2332005275db419f784ab18dfc21a25bcad
+  metadata.gz: 8aa99377c24ced53c356cbb1fbf7c37b261085011de8eb0c104c2fdbfef54f3befed765f5aabf3bffaee6e900b948e640b84891c9b51b22378a98b9a3ffcdddc
+  data.tar.gz: 97a5d39339fd28c51c003e1aa216c1174bcfbaa85d80f25c0ce87db98ecaf82dac2521ae3a89c6b271d470d5dcb460d795acc5f5c33b5194756a10ac1d4341a8

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# 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.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/README.md

@@ -334,18 +334,15 @@ Mailers and Controllers use the save decent_exposure dsl.
 
 ```ruby
 class PostMailer < ApplicationMailer
-  attr_accessor :post_id
-
   expose(:posts, -> { Post.last(10) })
-  expose(:post, id: -> { post_id })
+  expose(:post)
 
   def top_posts
     @greeting = "Top Posts"
     mail to: "to@example.org"
   end
 
-  def featured_post(post_id = nil)
-    self.post_id = post_id
+  def featured_post(id:)
     @greeting = "Featured Post"
     mail to: "to@example.org"
   end

data/decent_exposure.gemspec

@@ -24,5 +24,6 @@ Gem::Specification.new do |spec|
 
   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"
 end

data/lib/decent_exposure.rb

@@ -4,6 +4,7 @@ require "generators/decent_exposure/scaffold_templates_generator"
 
 module DecentExposure
   autoload :Controller, "decent_exposure/controller"
+  autoload :Mailer,     "decent_exposure/mailer"
   autoload :Exposure,   "decent_exposure/exposure"
   autoload :Attribute,  "decent_exposure/attribute"
   autoload :Context,    "decent_exposure/context"
@@ -16,5 +17,6 @@ module DecentExposure
 
   ActiveSupport.on_load :action_mailer do
     include Controller
+    include Mailer
   end
 end

data/lib/decent_exposure/context.rb

@@ -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/exposure.rb

@@ -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

data/lib/decent_exposure/mailer.rb

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

data/lib/decent_exposure/version.rb

@@ -1,3 +1,3 @@
 module DecentExposure
-  VERSION = "3.0.0"
+  VERSION = "3.0.1"
 end

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

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-describe DecentExposure::Controller do
+RSpec.describe DecentExposure::Controller do
   class Thing; end
   class DifferentThing; end
 
@@ -41,8 +41,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

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,70 @@
+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
+  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,44 @@
+require "spec_helper"
+require "support/rails_app"
+require "rspec/rails"
+require "action_mailer"
+
+class BirdsMailer < ActionMailer::Base
+end
+
+RSpec.describe BirdsMailer, type: :mailer do
+  let(:bird){ double :bird }
+  let(:birds) { double :birds }
+
+  context "when birds relation is exposed" do
+    class BirdsMailer
+      expose(:birds, -> { Bird.all })
+
+      def hello_birds
+        mail { |format| format.text { render plain: "Hello #{birds}" } }
+      end
+    end
+
+    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
+    class BirdsMailer
+      expose(:bird)
+
+      def hello_bird(id:)
+        mail { |format| format.text { render plain: "Hello #{bird}" } }
+      end
+    end
+
+    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
+end

data/spec/support/rails_app.rb

@@ -1,8 +1,11 @@
-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
@@ -10,28 +13,55 @@ module Rails
     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| self.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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decent_exposure
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Pavel Pravosud
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-01 00:00:00.000000000 Z
+date: 2016-10-26 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
@@ -67,6 +81,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -83,6 +98,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
@@ -97,9 +113,11 @@ 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
@@ -127,8 +145,10 @@ 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