decent_exposure 3.0.0.beta1 → 3.0.3

data/lib/decent_exposure/flow.rb

@@ -46,7 +46,7 @@ module DecentExposure
     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.beta1"
+  VERSION = "3.0.3"
 end

data/lib/generators/decent_exposure/USAGE

@@ -0,0 +1,13 @@
+Description:
+    Generate DecentExposure scaffold template files
+
+Example:
+    rails generate decent_exposure:scaffold_templates [--template_engine erb|haml]
+
+    This will create:
+        lib/templates/rails/scaffold_controller/controller.rb
+        lib/templates/erb/scaffold/_form.html.erb
+        lib/templates/erb/scaffold/edit.html.erb
+        lib/templates/erb/scaffold/index.html.erb
+        lib/templates/erb/scaffold/new.html.erb
+        lib/templates/erb/scaffold/show.html.erb

data/lib/generators/decent_exposure/scaffold_templates_generator.rb

@@ -0,0 +1,46 @@
+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)."
+
+      VIEWS = %i[_form edit index new show]
+      AVAILABLE_ENGINES = %w[erb haml]
+
+      def generate
+        validate_template_engine
+
+        generate_controller
+        VIEWS.each { |view| generate_view(view) }
+      end
+
+      private
+
+      def generate_controller
+        copy_template("rails/scaffold_controller", "controller.rb")
+      end
+
+      def generate_view(view)
+        copy_template("#{engine}/scaffold", "#{view}.html.#{engine}")
+      end
+
+      def copy_template(generator, file)
+        copy_file(file, "lib/templates/#{generator}/#{file}")
+      end
+
+      def engine
+        options[:template_engine]
+      end
+
+      def validate_template_engine
+        unless AVAILABLE_ENGINES.include?(engine.to_s)
+          message = "ERROR: template_engine must be: #{AVAILABLE_ENGINES}."
+          raise ArgumentError, message
+        end
+      end
+    end
+  end
+end

data/lib/generators/decent_exposure/templates/_form.html.erb

@@ -0,0 +1,34 @@
+<%%= form_for(<%= singular_table_name %>) do |f| %>
+  <%% if <%= singular_table_name %>.errors.any? %>
+    <div id="error_explanation">
+      <h2><%%= pluralize(<%= singular_table_name %>.errors.count, "error") %> prohibited this <%= singular_table_name %> from being saved:</h2>
+
+      <ul>
+      <%% <%= singular_table_name %>.errors.full_messages.each do |message| %>
+        <li><%%= message %></li>
+      <%% end %>
+      </ul>
+    </div>
+  <%% end %>
+
+<% attributes.each do |attribute| -%>
+  <div class="field">
+<% if attribute.password_digest? -%>
+    <%%= f.label :password %>
+    <%%= f.password_field :password %>
+  </div>
+
+  <div class="field">
+    <%%= f.label :password_confirmation %>
+    <%%= f.password_field :password_confirmation %>
+<% else -%>
+    <%%= f.label :<%= attribute.column_name %> %>
+    <%%= f.<%= attribute.field_type %> :<%= attribute.column_name %> %>
+<% end -%>
+  </div>
+
+<% end -%>
+  <div class="actions">
+    <%%= f.submit %>
+  </div>
+<%% end %>

data/lib/generators/decent_exposure/templates/_form.html.haml

@@ -0,0 +1,15 @@
+= form_for <%= singular_table_name %> do |f|
+  - if <%= singular_table_name %>.errors.any?
+    #error_explanation
+      %h2= "#{pluralize(<%= singular_table_name %>.errors.count, "error")} prohibited this <%= singular_table_name %> from being saved:"
+      %ul
+        - <%= singular_table_name %>.errors.full_messages.each do |msg|
+          %li= msg
+
+<% for attribute in attributes -%>
+  .field
+    = f.label :<%= attribute.name %>
+    = f.<%= attribute.field_type %> :<%= attribute.name %>
+<% end -%>
+  .actions
+    = f.submit 'Save'

data/lib/generators/decent_exposure/templates/controller.rb

@@ -0,0 +1,41 @@
+<% if namespaced? -%>
+require_dependency "<%= namespaced_path %>/application_controller"
+
+<% end -%>
+<% module_namespacing do -%>
+class <%= controller_class_name %>Controller < ApplicationController
+  expose :<%= plural_table_name %>, ->{ <%= orm_class.all(class_name) %> }
+  expose :<%= singular_table_name %>
+
+  def create
+    if <%= orm_instance.save %>
+      redirect_to <%= singular_table_name %>, notice: <%= "'#{human_name} was successfully created.'" %>
+    else
+      render :new
+    end
+  end
+
+  def update
+    if <%= orm_instance.update("#{singular_table_name}_params") %>
+      redirect_to <%= singular_table_name %>, notice: <%= "'#{human_name} was successfully updated.'" %>
+    else
+      render :edit
+    end
+  end
+
+  def destroy
+    <%= orm_instance.destroy %>
+    redirect_to <%= index_helper %>_url, notice: <%= "'#{human_name} was successfully destroyed.'" %>
+  end
+
+  private
+
+  def <%= "#{singular_table_name}_params" %>
+    <%- if attributes_names.empty? -%>
+    params.fetch(:<%= singular_table_name %>, {})
+    <%- else -%>
+    params.require(:<%= singular_table_name %>).permit(<%= attributes_names.map { |name| ":#{name}" }.join(', ') %>)
+    <%- end -%>
+  end
+end
+<% end -%>

data/lib/generators/decent_exposure/templates/edit.html.erb

@@ -0,0 +1,6 @@
+<h1>Editing <%= singular_table_name.titleize %></h1>
+
+<%%= render 'form', <%= singular_table_name %>: <%= singular_table_name %> %>
+
+<%%= link_to 'Show', <%= singular_table_name %> %> |
+<%%= link_to 'Back', <%= index_helper %>_path %>

data/lib/generators/decent_exposure/templates/edit.html.haml

@@ -0,0 +1,7 @@
+%h1 Editing <%= singular_table_name %>
+
+= render 'form'
+
+= link_to 'Show', <%= singular_table_name %>
+\|
+= link_to 'Back', <%= index_helper %>_path

data/lib/generators/decent_exposure/templates/index.html.erb

@@ -0,0 +1,31 @@
+<p id="notice"><%%= notice %></p>
+
+<h1><%= plural_table_name.titleize %></h1>
+
+<table>
+  <thead>
+    <tr>
+<% attributes.reject(&:password_digest?).each do |attribute| -%>
+      <th><%= attribute.human_name %></th>
+<% end -%>
+      <th colspan="3"></th>
+    </tr>
+  </thead>
+
+  <tbody>
+    <%% <%= plural_table_name %>.each do |<%= singular_table_name %>| %>
+      <tr>
+<% attributes.reject(&:password_digest?).each do |attribute| -%>
+        <td><%%= <%= singular_table_name %>.<%= attribute.name %> %></td>
+<% end -%>
+        <td><%%= link_to 'Show', <%= singular_table_name %> %></td>
+        <td><%%= link_to 'Edit', edit_<%= singular_table_name %>_path(<%= singular_table_name %>) %></td>
+        <td><%%= link_to 'Destroy', <%= singular_table_name %>, method: :delete, data: { confirm: 'Are you sure?' } %></td>
+      </tr>
+    <%% end %>
+  </tbody>
+</table>
+
+<br>
+
+<%%= link_to 'New <%= singular_table_name.titleize %>', new_<%= singular_table_name %>_path %>

data/lib/generators/decent_exposure/templates/index.html.haml

@@ -0,0 +1,25 @@
+%h1 Listing <%= plural_table_name %>
+
+%table
+  %thead
+    %tr
+<% for attribute in attributes -%>
+      %th <%= attribute.human_name %>
+<% end -%>
+      %th
+      %th
+      %th
+
+  %tbody
+    - <%= plural_table_name %>.each do |<%= singular_table_name %>|
+      %tr
+<% for attribute in attributes -%>
+        %td= <%= singular_table_name %>.<%= attribute.name %>
+<% end -%>
+        %td= link_to 'Show', <%= singular_table_name %>
+        %td= link_to 'Edit', edit_<%= singular_table_name %>_path(<%= singular_table_name %>)
+        %td= link_to 'Destroy', <%= singular_table_name %>, method: :delete, data: { confirm: 'Are you sure?' }
+
+%br
+
+= link_to 'New <%= human_name %>', new_<%= singular_table_name %>_path

data/lib/generators/decent_exposure/templates/new.html.erb

@@ -0,0 +1,5 @@
+<h1>New <%= singular_table_name.titleize %></h1>
+
+<%%= render 'form', <%= singular_table_name %>: <%= singular_table_name %> %>
+
+<%%= link_to 'Back', <%= index_helper %>_path %>

data/lib/generators/decent_exposure/templates/new.html.haml

@@ -0,0 +1,5 @@
+%h1 New <%= singular_table_name %>
+
+= render 'form'
+
+= link_to 'Back', <%= index_helper %>_path

data/lib/generators/decent_exposure/templates/show.html.erb

@@ -0,0 +1,11 @@
+<p id="notice"><%%= notice %></p>
+
+<% attributes.reject(&:password_digest?).each do |attribute| -%>
+<p>
+  <strong><%= attribute.human_name %>:</strong>
+  <%%= <%= singular_table_name %>.<%= attribute.name %> %>
+</p>
+
+<% end -%>
+<%%= link_to 'Edit', edit_<%= singular_table_name %>_path(<%= singular_table_name %>) %> |
+<%%= link_to 'Back', <%= index_helper %>_path %>

data/lib/generators/decent_exposure/templates/show.html.haml

@@ -0,0 +1,11 @@
+%p#notice= notice
+
+<% for attribute in attributes -%>
+%p
+  %b <%= attribute.human_name %>:
+  = <%= singular_table_name %>.<%= attribute.name %>
+<% end -%>
+
+= link_to 'Edit', edit_<%= singular_table_name %>_path(<%= singular_table_name %>)
+\|
+= link_to 'Back', <%= index_helper %>_path

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
@@ -197,7 +203,7 @@ describe DecentExposure::Controller do
         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