spree_scaffold 0.60.0.RC1

data/.gitignore

@@ -0,0 +1,9 @@
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+tmp
+nbproject
+*.swp

data/LICENSE

@@ -0,0 +1,23 @@
+Redistribution and use in source and binary forms, with or without modification, 
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice, 
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice, 
+      this list of conditions and the following disclaimer in the documentation 
+      and/or other materials provided with the distribution.
+    * Neither the name of the Rails Dog LLC nor the names of its 
+      contributors may be used to endorse or promote products derived from this 
+      software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,37 @@
+SpreeScaffold
+=============
+
+A basic admin scaffold generator for Spree.
+
+Creates a CRUD interface for whatever you want using the Spree admin styling.
+
+It also creates an admin menu item using Deface::Override in an initializer. Don't forget to restart the app for the button to show up in the admin menu bar.
+
+Example
+=======
+
+To install
+
+    gem "spree_scaffold", :git => 'git://github.com/sebastyuiop/spree_scaffold.git'
+
+To generate a scaffold:
+
+    rails g spree:scaffold Cat name:string colour:string
+
+Which produces:
+
+    create  app/models/cat.rb
+    create  app/controllers/admin/cats_controller.rb
+    create  app/views/admin/cats/index.html.erb
+    create  app/views/admin/cats/new.html.erb
+    create  app/views/admin/cats/edit.html.erb
+    create  app/views/admin/cats/_form.html.erb
+    create  db/migrate/20110620133021_create_cats.rb
+    create  config/locales/en_cats.yml
+    create  config/initializers/spree_scaffold_cats_hooks.rb
+    
+    rake db:migrate
+    
+You'll need to add a route under the admin namespace for the above (e.g resources :cats).
+
+Copyright (c) 2011 sebastyuiop, released under the New BSD License

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/Versionfile

@@ -0,0 +1,9 @@
+# This file is used to designate compatibilty with different versions of Spree
+# Please see http://spreecommerce.com/documentation/extensions.html#versionfile for details
+
+# Examples
+#
+# "0.50.x" => { :branch => "master" }
+# "0.40.x" => { :tag => "v1.0.0", :version => "1.0.0" }
+
+

data/lib/generators/spree/scaffold/USAGE

@@ -0,0 +1,18 @@
+Description:
+		A basic admin scaffold generator for Spree
+    Creates a CRUD interface for whatever you want using the Spree admin styling
+		It also creates an initializer that insert an admin menu item for the model you created
+
+Example:
+    rails generate spree:scaffold ModelName attribute_1:type_1 attribute_2:type_2
+
+    This will create:
+	    app/models/model_name.rb
+	    app/controllers/admin/model_names_controller.rb
+	    app/views/admin/model_names/index.html.erb
+	    app/views/admin/model_names/new.html.erb
+	    app/views/admin/model_names/edit.html.erb
+	    app/views/admin/model_names/_form.html.erb
+	    db/migrate/TIMESTAMP_create_model_names.rb
+	    config/locales/en_model_names.yml
+	    config/initializers/spree_scaffold_model_names_hooks.rb

data/lib/generators/spree/scaffold/scaffold_generator.rb

@@ -0,0 +1,79 @@
+require 'rails/generators'
+require 'rails/generators/generated_attribute'
+
+module Spree
+  module Generators
+    class ScaffoldGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+  
+      attr_accessor :scaffold_name, :model_attributes, :controller_actions
+      
+      argument :scaffold_name, :type => :string, :required => true, :banner => 'ModelName'
+      argument :model_attribute_args, :type => :array, :default => [], :banner => 'model:attributes'
+  
+      def initialize(*args, &block)
+        super
+        print_usage unless scaffold_name.underscore =~ /^[a-z][a-z0-9_\/]+$/
+    
+        @model_attributes = []
+        model_attribute_args.each do |arg|
+          if arg.include?(':')
+            @model_attributes << Rails::Generators::GeneratedAttribute.new(*arg.split(':'))
+          end
+        end
+      end
+      
+      def create_model
+        template 'model.rb', "app/models/#{model_path}.rb"
+      end
+  
+      def create_controller
+        template 'controller.rb', "app/controllers/admin/#{model_path.pluralize}_controller.rb"
+      end
+  
+      def create_views
+        ['index','new','edit'].each do |view|
+          template "views/#{view}.html.erb", "app/views/admin/#{model_path.pluralize}/#{view}.html.erb"
+        end
+        template "views/_form.html.erb", "app/views/admin/#{model_path.pluralize}/_form.html.erb"
+      end
+  
+      def create_migration
+        stamp =  Time.now.utc.strftime("%Y%m%d%H%M%S")
+        template 'migration.rb', "db/migrate/#{stamp}_create_#{model_path.pluralize}.rb"
+      end
+  
+      def create_locale
+        template 'en.yml', "config/locales/en_#{model_path.pluralize}.yml"
+      end
+
+      # Added back since using deface
+      def create_hooks
+        template 'hooks.rb', "config/initializers/spree_scaffold_#{model_path.pluralize}_hooks.rb"
+      end
+
+      private
+  
+      def model_path
+        scaffold_name.underscore.downcase
+      end
+  
+      def class_name
+        scaffold_name.camelize
+      end
+  
+      def table_name
+        scaffold_name.downcase.underscore.pluralize
+      end
+  
+      def display_name
+        scaffold_name.underscore.titleize
+      end
+  
+      def display_name_plural
+        scaffold_name.underscore.titleize.pluralize
+      end
+  
+    end
+  end
+end

data/lib/generators/spree/scaffold/templates/controller.rb

@@ -0,0 +1,42 @@
+class Admin::<%= class_name.pluralize %>Controller < Admin::ResourceController
+  
+  def index
+    @<%= model_path.pluralize %> = <%= class_name %>.page(params[:page] || 1).per(50)
+  end
+
+  def new
+    @<%= model_path %> = <%= class_name %>.new
+  end
+
+  def create
+    @<%= model_path %> = <%= class_name %>.new(params[:<%= model_path %>])
+    if @<%= model_path %>.save
+      flash[:notice] = "Successfully created <%= display_name %>."
+      redirect_to admin_<%= model_path.pluralize %>_url
+    else
+      render :action => 'new'
+    end
+  end
+
+  def edit
+    @<%= model_path %> = <%= class_name %>.find(params[:id])
+  end
+
+  def update
+    @page = <%= class_name %>.find(params[:id])
+    if @<%= model_path %>.update_attributes(params[:<%= model_path %>])
+      flash[:notice] = "Successfully updated <%= display_name %>."
+      redirect_to admin_<%= model_path.pluralize %>_url
+    else
+      render :action => 'edit'
+    end
+  end
+
+  def destroy
+    @<%= model_path %> = <%= class_name %>.find(params[:id])
+    @<%= model_path %>.destroy
+    flash[:notice] = "Successfully destroyed <%= display_name %>."
+    redirect_to admin_<%= model_path.pluralize %>_url
+  end
+
+end

data/lib/generators/spree/scaffold/templates/en.yml

@@ -0,0 +1,4 @@
+en:
+  new_<%= model_path %>: "New <%= display_name %>"
+  listing_<%= model_path.pluralize %>: "Listing <%= display_name_plural %>"
+  editing_<%= model_path %>: "Editing <%= display_name %>"

data/lib/generators/spree/scaffold/templates/hooks.rb

@@ -0,0 +1,5 @@
+Deface::Override.new(:virtual_path => 'layouts/admin',
+                     :name => 'add_<%= class_name %>_model_to_tabs',
+                     :insert_bottom => "[data-hook='admin_tabs']",
+                     :text => '<%%= tab(:<%= model_path.pluralize %>) %>',
+                     :disabled => false)

data/lib/generators/spree/scaffold/templates/migration.rb

@@ -0,0 +1,16 @@
+class Create<%= class_name.pluralize %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= model_path.pluralize %> do |t|
+    <%- for attribute in model_attributes -%>
+      t.<%= attribute.type %> :<%= attribute.name %>
+    <%- end -%>
+    <%- unless options[:skip_timestamps] -%>
+      t.timestamps
+    <%- end -%>
+    end
+  end
+
+  def self.down
+    drop_table :<%= model_path.pluralize %>
+  end
+end

data/lib/generators/spree/scaffold/templates/model.rb

@@ -0,0 +1,3 @@
+class <%= class_name %> < ActiveRecord::Base
+  
+end

data/lib/generators/spree/scaffold/templates/views/_form.html.erb

@@ -0,0 +1,6 @@
+<%- for attribute in model_attributes -%>
+<p>
+  <%%= f.label :<%= attribute.name %> %><br />
+  <%%= f.<%= attribute.field_type %> :<%= attribute.name %> %>
+</p>
+<%- end -%>

data/lib/generators/spree/scaffold/templates/views/edit.html.erb

@@ -0,0 +1,14 @@
+<%%= hook :admin_<%= model_path %>_edit_form_header do %>
+  <%%= render 'shared/error_messages', :target => @<%= model_path %> %>
+  <h1><%%= t("editing_<%= model_path %>") %></h1>
+<%% end %>
+
+<%%= hook :admin_<%= model_path %>_edit_form do %>
+  <%%= form_for(:<%= model_path %>, :url => object_url, :html => { :method => :put }) do |f| %>
+    <%%= render :partial => "form", :locals => { :f => f } %>
+
+    <%%= hook :admin_<%= model_path %>_edit_form_buttons do %>
+      <%%= render :partial => "admin/shared/edit_resource_links" %>
+    <%% end %>
+  <%% end %>
+<%% end %>

data/lib/generators/spree/scaffold/templates/views/index.html.erb

@@ -0,0 +1,36 @@
+<div class='toolbar'>
+  <ul class='actions'>
+    <li>
+      <p><%%= button_link_to t("new_<%= model_path %>"), new_object_url, :icon => 'add' %></p>
+    </li>
+  </ul>
+  <br class='clear' />
+</div>
+
+<h1><%%= t("listing_<%= model_path.pluralize %>") %></h1>
+
+<table class="index">
+  <thead>
+  <tr>
+    <% for attribute in model_attributes -%>
+      <th><%= attribute.name %></th>
+    <% end %>
+    <th>&nbsp;</th>
+  </tr>
+  </thead>
+  <tbody>
+    <%% @<%= model_path.pluralize %>.each do |<%= model_path %>|%>
+      <tr id="<%%= dom_id <%= model_path %> %>">
+        <% for attribute in model_attributes -%>
+          <td width="350px"><%%= link_to <%= model_path %>.<%= attribute.name %>, edit_object_url(<%= model_path %>) %></td>
+        <% end %>
+        <td>
+          <%%= link_to_edit <%= model_path %> %> &nbsp;
+          <%%= link_to_delete <%= model_path %> %>
+        </td>
+      </tr>
+    <%% end %>
+  </tbody>
+</table>
+
+<%%= paginate @<%= model_path.pluralize %> %>

data/lib/generators/spree/scaffold/templates/views/new.html.erb

@@ -0,0 +1,14 @@
+<%%= hook :admin_<%= model_path %>_new_form_header do %>
+  <%%= render 'shared/error_messages', :target => @<%= model_path %> %>
+  <h1><%%= t("new_<%= model_path %>") %></h1>
+<%% end %>
+
+<%%= hook :admin_<%= model_path %>_new_form do %>
+  <%%= form_for(:<%= model_path %>, :url => collection_url) do |f| %>
+    <%%= render :partial => "form", :locals => { :f => f } %>
+
+    <%%= hook :admin_<%= model_path %>_new_form_buttons do %>
+      <%%= render :partial => "admin/shared/new_resource_links" %>
+    <%% end %>
+  <%% end %>
+<%% end %>

data/lib/spree_scaffold.rb

@@ -0,0 +1,18 @@
+require 'deface'
+require 'spree_core'
+require 'spree_scaffold_hooks'
+
+module SpreeScaffold
+  class Engine < Rails::Engine
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), "../app/**/*_decorator*.rb")) do |c|
+        Rails.env.production? ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare &method(:activate).to_proc
+  end
+end

data/lib/spree_scaffold_hooks.rb

@@ -0,0 +1,3 @@
+class SpreeScaffoldHooks < Spree::ThemeSupport::HookListener
+  # custom hooks go here
+end

data/lib/tasks/install.rake

@@ -0,0 +1,29 @@
+namespace :spree do
+  
+  namespace :scaffold do
+  
+    desc "Copies all migrations and assets (NOTE: This will be obsolete with Rails 3.1)"
+    task :install do
+      Rake::Task['spree:scaffold:install:migrations'].invoke
+      Rake::Task['spree:scaffold:install:assets'].invoke
+    end
+
+    namespace :install do
+      desc "Copies all migrations (NOTE: This will be obsolete with Rails 3.1)"
+      task :migrations do
+        source = File.join(File.dirname(__FILE__), '..', '..', 'db')
+        destination = File.join(Rails.root, 'db')
+        Spree::FileUtilz.mirror_files(source, destination)
+      end
+
+      desc "Copies all assets (NOTE: This will be obsolete with Rails 3.1)"
+      task :assets do
+        source = File.join(File.dirname(__FILE__), '..', '..', 'public')
+        destination = File.join(Rails.root, 'public')
+        puts "INFO: Mirroring assets from #{source} to #{destination}"
+        Spree::FileUtilz.mirror_files(source, destination)
+      end
+    end
+
+  end
+end

data/lib/tasks/spree_scaffold.rake

@@ -0,0 +1 @@
+# add custom rake tasks here

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+# This file is copied to ~/spec when you run 'ruby script/generate rspec'
+# from the project root directory.
+ENV["RAILS_ENV"] ||= 'test'
+require File.expand_path("../test_app/config/environment", __FILE__)
+require 'rspec/rails'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  #config.include Devise::TestHelpers, :type => :controller
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, comment the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+end
+
+@configuration ||= AppConfiguration.find_or_create_by_name("Default configuration")

data/spree_scaffold.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'spree_scaffold'
+  s.version     = '0.60.0.RC1'
+  s.summary     = 'Add gem summary here'
+  s.description = 'Add (optional) gem description here'
+  s.required_ruby_version = '>= 1.8.7'
+
+  s.author            = 'Seb Weston'
+  s.email             = 'seb@example.com'
+  s.homepage          = 'http://www.github.com/sebastyuiop'
+#  s.rubyforge_project = 'actionmailer'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_path = 'lib'
+  s.requirements << 'none'
+
+  s.add_dependency('spree_core', '>= 0.60.0.RC1')
+  s.add_dependency('deface', '> 0')
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: spree_scaffold
+version: !ruby/object:Gem::Version
+  version: 0.60.0.RC1
+  prerelease: 7
+platform: ruby
+authors:
+- Seb Weston
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spree_core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.60.0.RC1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.60.0.RC1
+- !ruby/object:Gem::Dependency
+  name: deface
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Add (optional) gem description here
+email: seb@example.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- Versionfile
+- lib/generators/spree/scaffold/USAGE
+- lib/generators/spree/scaffold/scaffold_generator.rb
+- lib/generators/spree/scaffold/templates/controller.rb
+- lib/generators/spree/scaffold/templates/en.yml
+- lib/generators/spree/scaffold/templates/hooks.rb
+- lib/generators/spree/scaffold/templates/migration.rb
+- lib/generators/spree/scaffold/templates/model.rb
+- lib/generators/spree/scaffold/templates/views/_form.html.erb
+- lib/generators/spree/scaffold/templates/views/edit.html.erb
+- lib/generators/spree/scaffold/templates/views/index.html.erb
+- lib/generators/spree/scaffold/templates/views/new.html.erb
+- lib/spree_scaffold.rb
+- lib/spree_scaffold_hooks.rb
+- lib/tasks/install.rake
+- lib/tasks/spree_scaffold.rake
+- spec/spec_helper.rb
+- spree_scaffold.gemspec
+homepage: http://www.github.com/sebastyuiop
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements:
+- none
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Add gem summary here
+test_files:
+- spec/spec_helper.rb