decent_exposure 3.0.0.beta1 → 3.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ec6d62cc52928970902ade2a9998e8f58758f7c
-  data.tar.gz: 0a3aff2440f88ed56a20197d270402c826c6b5e3
+  metadata.gz: 7cfd8c745c922accdd68b09011ac06094d2c71bc
+  data.tar.gz: 3eab645e6e2b13e763cbe6835125ec8104730c9d
 SHA512:
-  metadata.gz: c085171f6369dda3d9ae3f459aed654dcdc5a0934f28b61b605ffa1cbff9951cc5b44b214179d3969764064c748c7cddac8dc58655c7972f09dcaa6c5bec0bff
-  data.tar.gz: 692f0b40e7d1435ebaec5ac4d96422b8cb69592afcb3b5010c597f71f65f7c3f88588ee26dffd17ae38cd83ad269f5fa1581030bbf132ea3c4a63a8b38d1bf81
+  metadata.gz: 7413bd28015045c87343f8bcc3210a46964420782f96c016fb2687c8f07a4ce26cdeb5868f35b9c376934593f36973fcfca2d1955bba40cd3b6e5ee4864bd67a
+  data.tar.gz: 92bb65c55c3c2f5902b93cb24ab54dadaf52b844360f377d49736df2b261e949f7130b551d9ad4b719625013ffe7398435efddbf00bd31aaaf35659d34f70120

data/.travis.yml

@@ -1,3 +1,15 @@
+language: ruby
 rvm:
   - 2.2.2
   - 2.3.0
+gemfile:
+  - Gemfile
+  - gemfiles/Gemfile.rails-5.0.0.rc1
+  - 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/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.beta1'
 ```
 
 And then execute:
@@ -48,7 +50,7 @@ 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
@@ -323,6 +325,20 @@ expose :thing, with: [:cool_find, :cool_build]
 expose :another_thing, with: :cool_build
 ```
 
+## 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. 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)

data/decent_exposure.gemspec

@@ -22,9 +22,7 @@ Gem::Specification.new do |spec|
 
   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 "rspec-rails", "~> 3.0"
-  spec.add_development_dependency "rake", "~> 10.3"
-  spec.add_development_dependency "pry"
 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.rc1

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

data/lib/decent_exposure.rb

@@ -1,5 +1,6 @@
 require "decent_exposure/version"
 require "active_support/all"
+require "generators/decent_exposure/scaffold_templates_generator"
 
 module DecentExposure
   autoload :Controller, "decent_exposure/controller"

data/lib/decent_exposure/version.rb

@@ -1,3 +1,3 @@
 module DecentExposure
-  VERSION = "3.0.0.beta1"
+  VERSION = "3.0.0.beta2"
 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/generators/decent_exposure/scaffold_templates_generator_spec.rb

@@ -0,0 +1,46 @@
+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')
+
+      generator.generate
+    end
+  end
+
+  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')
+
+      generator.generate
+    end
+  end
+
+  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
+      expect { generator.generate }. to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/integration_spec.rb

@@ -9,17 +9,17 @@ describe BirdsController, type: :controller do
     after{ expect(controller.bird).to eq(mockingbird) }
 
     it "finds model by id" do
-      get :show, params: { id: "mockingbird" }
+      get :show, { id: "mockingbird" }
     end
 
     it "finds model by bird_id" do
-      get :show, params: { bird_id: "mockingbird" }
+      get :show, { bird_id: "mockingbird" }
     end
   end
 
   it "builds bird if id is not provided" do
     bird = double("Bird")
-    expect(Bird).to receive(:new).and_return(bird)
+    expect(Bird).to receive(:new).with({}).and_return(bird)
     get :show
     expect(controller.bird).to eq(bird)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decent_exposure
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta1
+  version: 3.0.0.beta2
 platform: ruby
 authors:
 - Pavel Pravosud
@@ -9,36 +9,36 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-08 00:00:00.000000000 Z
+date: 2016-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.x
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.x
+        version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.x
-  type: :runtime
+        version: '4.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.x
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -53,34 +53,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.3'
-- !ruby/object:Gem::Dependency
-  name: pry
-  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
@@ -101,6 +73,9 @@ files:
 - Rakefile
 - decent_exposure.gemspec
 - 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
 - lib/decent_exposure.rb
 - lib/decent_exposure/attribute.rb
@@ -110,7 +85,21 @@ files:
 - lib/decent_exposure/exposure.rb
 - lib/decent_exposure/flow.rb
 - lib/decent_exposure/version.rb
+- lib/generators/decent_exposure/USAGE
+- lib/generators/decent_exposure/scaffold_templates_generator.rb
+- lib/generators/decent_exposure/templates/_form.html.erb
+- lib/generators/decent_exposure/templates/_form.html.haml
+- lib/generators/decent_exposure/templates/controller.rb
+- lib/generators/decent_exposure/templates/edit.html.erb
+- lib/generators/decent_exposure/templates/edit.html.haml
+- lib/generators/decent_exposure/templates/index.html.erb
+- lib/generators/decent_exposure/templates/index.html.haml
+- lib/generators/decent_exposure/templates/new.html.erb
+- 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/generators/decent_exposure/scaffold_templates_generator_spec.rb
 - spec/integration_spec.rb
 - spec/spec_helper.rb
 - spec/support/rails_app.rb
@@ -134,12 +123,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: A helper for creating declarative interfaces in controllers
 test_files:
 - spec/controller_spec.rb
+- spec/generators/decent_exposure/scaffold_templates_generator_spec.rb
 - spec/integration_spec.rb
 - spec/spec_helper.rb
 - spec/support/rails_app.rb