rails-admin-scaffold 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e1fac9b29b5562ab5219bf487e07bf173c8ba84
-  data.tar.gz: bf8cc2870b83ef67ee11d82d057edf3987b5f7c0
+  metadata.gz: a96266607b8ef504727c283ca1094422c7f6c8f4
+  data.tar.gz: 4bccc40dc64fd7b2d1e32ecd1b2994fad397ba0a
 SHA512:
-  metadata.gz: 482201651a09ede8bec6c05f08f3e467220ee4d0b81193e5c5aeec0817e208039e065565b280e9150f5d391541ab3c74e7c333bfda145654ec105b516d48d33a
-  data.tar.gz: 6fef87346c1730351ee0712d342c89d43b9bd2731633a9e6edfb4808fabdb40ae0340af7ae64b300b80b6bf180992181c1a8136b187e616f515d48cd69955f11
+  metadata.gz: b94c0bbb4e6f67110212755cd457293284e5634031b71dc188adfa053dc19e0d3ccf2c0dfccd0e179bccfe335c9dc504a7f6961106d53d06d267065d0e9be8fc
+  data.tar.gz: 87b2f9c8a3e22a3c301582678d270064d28596d60afd6a7cf5bcf9c73ca9742c9df5bb4fbfeee2aafb4efbd36acbc798b1f16ed70237304483c9cd9c2ce91ddc

data/README.md

@@ -1,17 +1,27 @@
-rails-admin-scaffold
+rails-admin-scaffold [![Build Status](https://travis-ci.org/dhampik/rails-admin-scaffold.png?branch=master)](https://travis-ci.org/dhampik/rails-admin-scaffold)
 ====================
 
-Rails generator which allows to scaffold admin controllers, views with proper (non-namespaced) models, helpers, tests and routes
+Rails 4 generator which allows to scaffold admin controllers, views with proper (non-namespaced) models, helpers, tests and routes
 
-How to use:
+How to use
 -----------
 * Add ```gem 'rails-admin-scaffold', 'x.x.x'``` to your Gemfile
 * Run ```bundle install```
 * Create admin scaffold with e. g. ```bin/rails g admin:scaffold_controller Post title:string content:text published:boolean```
 
-Plans:
+Supports
+--------
+* Rails 4 only
+* Rails default generators (erb, test::unit)
+* Haml (if haml is used for views generation)
+* Jbuilder (if jbuilder is installed for the project)
+
+Plans
 ------
-* add haml suppurt
-* add jbuilder support
-* improve tests
-* use travis for ci
+* <del>add haml suppurt</del>
+* <del>add jbuilder support</del>
+* <del>improve tests</del>
+* <del>use travis for ci</del>
+* add minitest support
+* add rspec support
+* split controller_scaffold into several separate generators

data/lib/generators/admin/scaffold_controller/scaffold_controller_generator.rb

@@ -1,3 +1,4 @@
+require 'rubygems/specification'
 require 'rails/generators/named_base'
 require 'rails/generators/resource_helpers'
 
@@ -8,6 +9,8 @@ module Admin
 
       source_root File.expand_path('../templates', __FILE__)
 
+      class_option :template_engine, desc: 'Template engine to be invoked (erb or haml).'
+
       check_class_collision suffix: "Controller"
 
       check_class_collision suffix: "ControllerTest"
@@ -31,12 +34,17 @@ module Admin
       end
 
       def create_controller_files
-        template "controllers/controller.erb", File.join('app/controllers', prefix, class_path, "#{controller_file_name}_controller.rb")
+        # I think there should be a better way to detect if jbuilder is in use
+        # If you know it, please let me know
+        if Gem::Specification.find_all_by_name('jbuilder').length >= 1
+          template "controllers/jbuilder/controller.rb.erb", File.join('app/controllers', prefix, class_path, "#{controller_file_name}_controller.rb")
+        else
+          template "controllers/railties/controller.rb.erb", File.join('app/controllers', prefix, class_path, "#{controller_file_name}_controller.rb")
+        end
       end
 
       def create_test_files
-        template "tests/test_unit/functional_test.erb",
-                 File.join("test/controllers", prefix, controller_class_path, "#{controller_file_name}_controller_test.rb")
+        template "tests/test_unit/functional_test.rb.erb", File.join("test/controllers", prefix, controller_class_path, "#{controller_file_name}_controller_test.rb")
       end
 
       hook_for :helper, in: :rails do |helper|
@@ -50,7 +58,14 @@ module Admin
       def copy_view_files
         available_views.each do |view|
           filename = filename_with_extensions(view)
-          template "views/#{handler}/#{filename}", File.join("app/views", prefix, controller_file_path, filename)
+          template "views/#{handler}/#{filename}.erb", File.join("app/views", prefix, controller_file_path, filename)
+        end
+
+        # I think there should be a better way to detect if jbuilder is in use
+        if Gem::Specification.find_all_by_name('jbuilder').length >= 1
+          %w(index show).each do |view|
+            template "views/jbuilder/#{view}.json.jbuilder.erb", File.join("app/views", prefix, controller_file_path, "#{view}.json.jbuilder")
+          end
         end
       end
 
@@ -93,7 +108,7 @@ module Admin
       end
 
       def handler
-        :erb
+        options[:template_engine]
       end
 
       def filename_with_extensions(name)
@@ -136,6 +151,18 @@ module Admin
         end.sort.join(', ')
       end
 
+      def attributes_list_with_timestamps
+        attributes_list(attributes_names + %w(created_at updated_at))
+      end
+
+      def attributes_list(attributes = attributes_names)
+        if self.attributes.any? {|attr| attr.name == 'password' && attr.type == :digest}
+          attributes = attributes.reject {|name| %w(password password_confirmation).include? name}
+        end
+
+        attributes.map { |a| ":#{a}"} * ', '
+      end
+
     end
   end
 end

data/lib/generators/admin/scaffold_controller/templates/controllers/jbuilder/controller.rb.erb

@@ -0,0 +1,84 @@
+<% if namespaced? -%>
+require_dependency "<%= namespaced_file_path %>/application_controller"
+
+<% end -%>
+<% module_namespacing do -%>
+class <%= prefixed_controller_class_name %>Controller < ApplicationController
+  before_action :set_<%= singular_table_name %>, only: [:show, :edit, :update, :destroy]
+
+  # GET <%= prefixed_route_url %>
+  # GET <%= prefixed_route_url %>.json
+  def index
+    @<%= plural_table_name %> = <%= orm_class.all(class_name) %>
+  end
+
+  # GET <%= prefixed_route_url %>/1
+  # GET <%= prefixed_route_url %>/1.json
+  def show
+  end
+
+  # GET <%= prefixed_route_url %>/new
+  def new
+    @<%= singular_table_name %> = <%= orm_class.build(class_name) %>
+  end
+
+  # GET <%= prefixed_route_url %>/1/edit
+  def edit
+  end
+
+  # POST <%= prefixed_route_url %>
+  # POST <%= prefixed_route_url %>.json
+  def create
+    @<%= singular_table_name %> = <%= orm_class.build(class_name, "#{singular_table_name}_params") %>
+
+    respond_to do |format|
+      if @<%= orm_instance.save %>
+        format.html { redirect_to <%= "[:#{prefix}, @#{singular_table_name}]" %>, notice: <%= "'#{human_name} was successfully created.'" %> }
+        format.json { render action: 'show', status: :created, location: <%= "@#{singular_table_name}" %> }
+      else
+        format.html { render action: 'new' }
+        format.json { render json: <%= "@#{orm_instance.errors}" %>, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # PATCH/PUT <%= prefixed_route_url %>/1
+  # PATCH/PUT <%= prefixed_route_url %>/1.json
+  def update
+    respond_to do |format|
+      if @<%= orm_instance.update("#{singular_table_name}_params") %>
+        format.html { redirect_to <%= "[:#{prefix}, @#{singular_table_name}]" %>, notice: <%= "'#{human_name} was successfully updated.'" %> }
+        format.json { head :no_content }
+      else
+        format.html { render action: 'edit' }
+        format.json { render json: <%= "@#{orm_instance.errors}" %>, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE <%= prefixed_route_url %>/1
+  # DELETE <%= prefixed_route_url %>/1.json
+  def destroy
+    @<%= orm_instance.destroy %>
+    respond_to do |format|
+      format.html { redirect_to <%= prefixed_index_helper %>_url, notice: <%= "'#{human_name} was successfully destroyed.'" %> }
+      format.json { head :no_content }
+    end
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_<%= singular_table_name %>
+      @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
+    end
+
+    # Never trust parameters from the scary internet, only allow the white list through.
+    def <%= "#{singular_table_name}_params" %>
+      <%- if attributes_names.empty? -%>
+      params[<%= ":#{singular_table_name}" %>]
+      <%- else -%>
+      params.require(<%= ":#{singular_table_name}" %>).permit(<%= attributes_names.map { |name| ":#{name}" }.join(', ') %>)
+      <%- end -%>
+    end
+end
+<% end -%>

data/lib/generators/admin/scaffold_controller/templates/views/haml/_form.html.haml.erb

@@ -0,0 +1,15 @@
+= form_for(<%= "[:#{prefix}, @#{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/admin/scaffold_controller/templates/views/haml/edit.html.haml.erb

@@ -0,0 +1,7 @@
+%h1 Editing <%= singular_table_name %>
+
+= render 'form'
+
+= link_to 'Show', <%= "[:#{prefix}, @#{singular_table_name}]" %>
+\|
+= link_to 'Back', <%= prefixed_index_helper %>_path

data/lib/generators/admin/scaffold_controller/templates/views/haml/index.html.haml.erb

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

data/lib/generators/admin/scaffold_controller/templates/views/haml/new.html.haml.erb

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

data/lib/generators/admin/scaffold_controller/templates/views/haml/show.html.haml.erb

@@ -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_<%= prefixed_plain_model_url %>_path(@<%= singular_table_name %>)
+\|
+= link_to 'Back', <%= prefixed_index_helper %>_path

data/lib/generators/admin/scaffold_controller/templates/views/jbuilder/index.json.jbuilder.erb

@@ -0,0 +1,4 @@
+json.array!(@<%= plural_table_name %>) do |<%= singular_table_name %>|
+  json.extract! <%= singular_table_name %>, <%= attributes_list %>
+  json.url <%= singular_table_name %>_url(<%= singular_table_name %>, format: :json)
+end

data/lib/generators/admin/scaffold_controller/templates/views/jbuilder/show.json.jbuilder.erb

@@ -0,0 +1 @@
+json.extract! @<%= singular_table_name %>, <%= attributes_list_with_timestamps %>

data/lib/rails-admin-scaffold/version.rb

@@ -1,3 +1,3 @@
 module RailsAdminScaffold
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/lib/generators/admin/scaffold_controller_generator_test.rb

@@ -65,7 +65,7 @@ class Admin::Generators::ScaffoldControllerGeneratorTest < Rails::Generators::Te
     assert_file "test/helpers/admin/users_helper_test.rb", /class Admin::UsersHelperTest < ActionView::TestCase/
   end
 
-  def test_views_are_generated
+  def test_erb_views_are_generated
     run_generator
 
     %w(index edit new show).each do |view|
@@ -73,6 +73,14 @@ class Admin::Generators::ScaffoldControllerGeneratorTest < Rails::Generators::Te
     end
   end
 
+  def test_haml_views_are_generated
+    run_generator ['user', '-e', 'haml']
+
+    %w(index edit new show).each do |view|
+      assert_file "app/views/admin/users/#{view}.html.haml"
+    end
+  end
+
   def test_functional_tests
     run_generator ["User", "name:string", "age:integer", "organization:references{polymorphic}"]
 

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: rails-admin-scaffold
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Kirill Kalachev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-15 00:00:00.000000000 Z
+date: 2013-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -30,26 +30,6 @@ dependencies:
     - - <
       - !ruby/object:Gem::Version
         version: '4.1'
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '3.1'
-    - - <
-      - !ruby/object:Gem::Version
-        version: '4.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '3.1'
-    - - <
-      - !ruby/object:Gem::Version
-        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -89,13 +69,21 @@ files:
 - LICENSE
 - README.md
 - lib/rails-admin-scaffold/version.rb
-- lib/generators/admin/scaffold_controller/templates/tests/test_unit/functional_test.erb
-- lib/generators/admin/scaffold_controller/templates/controllers/controller.erb
-- lib/generators/admin/scaffold_controller/templates/views/erb/new.html.erb
-- lib/generators/admin/scaffold_controller/templates/views/erb/show.html.erb
-- lib/generators/admin/scaffold_controller/templates/views/erb/edit.html.erb
-- lib/generators/admin/scaffold_controller/templates/views/erb/index.html.erb
-- lib/generators/admin/scaffold_controller/templates/views/erb/_form.html.erb
+- lib/generators/admin/scaffold_controller/templates/tests/test_unit/functional_test.rb.erb
+- lib/generators/admin/scaffold_controller/templates/controllers/jbuilder/controller.rb.erb
+- lib/generators/admin/scaffold_controller/templates/controllers/railties/controller.rb.erb
+- lib/generators/admin/scaffold_controller/templates/views/haml/new.html.haml.erb
+- lib/generators/admin/scaffold_controller/templates/views/haml/_form.html.haml.erb
+- lib/generators/admin/scaffold_controller/templates/views/haml/show.html.haml.erb
+- lib/generators/admin/scaffold_controller/templates/views/haml/edit.html.haml.erb
+- lib/generators/admin/scaffold_controller/templates/views/haml/index.html.haml.erb
+- lib/generators/admin/scaffold_controller/templates/views/jbuilder/show.json.jbuilder.erb
+- lib/generators/admin/scaffold_controller/templates/views/jbuilder/index.json.jbuilder.erb
+- lib/generators/admin/scaffold_controller/templates/views/erb/show.html.erb.erb
+- lib/generators/admin/scaffold_controller/templates/views/erb/_form.html.erb.erb
+- lib/generators/admin/scaffold_controller/templates/views/erb/new.html.erb.erb
+- lib/generators/admin/scaffold_controller/templates/views/erb/edit.html.erb.erb
+- lib/generators/admin/scaffold_controller/templates/views/erb/index.html.erb.erb
 - lib/generators/admin/scaffold_controller/scaffold_controller_generator.rb
 - lib/generators/admin/scaffold_controller/USAGE
 - lib/rails_admin_scaffold.rb