nsweb-generators 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+config/database.yml
+config/*.sphinx.conf
+*~
+*.cache
+*.log
+*.pid
+tmp/**/*
+.DS_Store
+db/*.sqlite3
+doc/api
+doc/app
+doc/plugins
+doc/*.dot
+coverate/*
+*.sw?
+vendor/plugins/ns_web
+Gemfile.lock
+*.gem

data/Gemfile

@@ -0,0 +1,8 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.0.3'
+
+group :test, :development do
+  gem 'rspec-rails',    '~> 2.0.1'
+  gem 'cucumber',       '~> 0.9.2'
+end

data/features/nsweb_controller.feature

@@ -0,0 +1,29 @@
+Feature: Nsweb Controller Generator
+		Inside of the Nsweb application
+		As a rails developer
+		I want to generate a controller for a resource
+
+		Scenario: Generate a controller for a simple resource inside the core engine
+				Given a new whizbang app
+				Given a core engine
+				
+				When I run "rails g nsweb:controller core Widget"
+				Then I should see the following files
+						| vendor/whizbang_app/core/app/controllers/widgets_controller.rb	|
+						| vendor/whizbang_app/core/app/helpers/widgets_helper.rb					|
+
+				And I should see "resources :widgets" in file "vendor/whizbang_app/core/config/routes.rb"
+				When I run "rake db:migrate"
+				Then I should successfully run "rake test"
+
+		Scenario: Generate controller with rspec tests
+				Given a new whizbang app
+				Given a core engine
+
+				When I run "rails g nsweb:controller core Widget --rspec"
+				Then I should see the following files
+						| vendor/whizbang_app/core/spec/controllers/widgets_controller_spec.rb	|
+				When I run "rake db:migrate"
+				And I add "gem 'rspec-rails', '>= 2.0.1'" to file "Gemfile"
+				And I run "rails g rspec:install"
+				Then I should successfully run "rake spec"

data/features/nsweb_engine.feature

@@ -0,0 +1,12 @@
+Feature: Nsweb Engine Generator
+		Inside of a rails application
+		As a rails developer
+		I want to generate an engine
+
+		Scenario: Generate a core engine
+				Given a new rails app
+
+				When I run "rails g nsweb:engine core"
+				Then I should see the following files
+						| vendor/rails_app/core/lib/core.rb				|
+						| vendor/rails_app/core/config/routes.rb	|

data/features/nsweb_model.feature

@@ -0,0 +1,27 @@
+Feature: Nsweb Model Generator
+		Inside of the Nsweb application
+		As a rails developer
+		I want to generate a model for a resource
+
+		Scenario: Generate a model for a simple resource inside the core engine
+				Given a new whizbang app
+				Given a core engine
+
+				When I run "rails g nsweb:model core Widget myvar:string"
+				Then I should see the following files
+						| vendor/whizbang_app/core/app/models/widget.rb		|
+						| db/migrate																			|
+				When I run "rake db:migrate"
+				Then I should successfully run "rake test"
+
+		Scenario: Generate a model with rspec tests
+				Given a new whizbang app
+				Given a core engine
+
+				When I run "rails g nsweb:model core widget myvar:string --rspec"
+				Then I should see the following files
+					| vendor/whizbang_app/core/spec/models/widget_spec.rb	|
+				When I run "rake db:migrate"
+				And I add "gem 'rspec-rails', '>= 2.0.1'" to file "Gemfile"
+				And I run "rails g rspec:install"
+				Then I should successfully run "rake spec"

data/features/step_definitions/common_steps.rb

@@ -0,0 +1,25 @@
+When /^I run "([^\"]*)"$/ do |command|
+  system("cd #{@current_directory} && #{command}").should be_true
+end
+
+When /^I add "([^\"]*)" to file "([^\"]*)"$/ do |content, short_path|
+  path = File.join(@current_directory, short_path)
+  File.should exist(path)
+  File.open(path, 'a') { |f| f.write(content + "\n") }
+end
+
+Then /^I should see "(.*)" in file "([^\"]*)"$/ do |content, short_path|
+  path = File.join(@current_directory, short_path)
+  File.should exist(path)
+  File.readlines(path).join.should include(content)
+end
+
+Then /^I should see the following files$/ do |table|
+  table.raw.flatten.each do |path|
+    File.should exist(File.join(@current_directory, path))
+  end
+end
+
+Then /^I should successfully run "([^\"]*)"$/ do |command|
+  system("cd #{@current_directory} && #{command}").should be_true
+end

data/features/step_definitions/setup_steps.rb

@@ -0,0 +1,11 @@
+Given /^a new ([a-z_]*) app$/ do |app_name|
+  FileUtils.mkdir_p('tmp')
+  system('rm -rf tmp/*')
+  system("rails new tmp/#{app_name}_app")
+  system("ln -s ../../../lib/generators tmp/#{app_name}_app/lib/generators").should be_true
+  @current_directory = File.expand_path("tmp/#{app_name}_app")
+end
+
+Given /^a ([a-z_]*) engine$/ do |engine_name|
+  system("cd #{@current_directory} && rails g nsweb:engine #{engine_name}")
+end

data/lib/generators/nsweb.rb

@@ -0,0 +1,108 @@
+require 'rails/generators'
+require 'rails/generators/base'
+
+module Nsweb
+  module Generators
+    class Base < Rails::Generators::Base #:nodoc:
+      attr_accessor :engine_name
+
+      argument :engine_name, :type => :string, :required => true, :banner => 'EngineName'
+
+      def self.source_root
+        @nsweb_source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'nsweb', generator_name, 'templates'))
+      end
+
+      def self.banner
+        "#{$0} generate nsweb:#{generator_name} #{self.arguments.map{ |a| a.usage }.join(' ')} [options]"
+      end
+
+      protected
+
+      def application_name
+        if defined?(Rails) && Rails.application
+          Rails.application.class.name.split('::').first.underscore
+        else
+          'application'
+        end
+      end
+
+      def engine_path
+        @engine_path ||= File.join('vendor', application_name, engine_name.underscore)
+      end
+
+      def engine_route(routing_code)
+        sentinel = /\.routes\.draw do(?:\s*\|map\|)?\s*$/
+        in_root do
+          inject_into_file File.join(engine_path, 'config/routes.rb' ),
+            "\n  #{routing_code}\n", { :after => sentinel, :verbose => false }
+        end
+      end
+
+      def test_framework
+        return @test_framework if defined?(@test_framework)
+        if options.rspec?
+          return @test_framework = :rspec
+        else
+          return @test_framework = default_test_framework
+        end
+      end
+
+      def default_test_framework
+        File.exist?(File.join(destination_root, 'spec')) ? :rspec : :testunit
+      end
+    end
+
+    class NamedBase < Base
+
+      argument :name, :type => :string
+
+      def initialize(args, *options)
+        super
+        assign_names!(self.name)
+      end
+
+      protected
+
+      attr_reader :class_path, :file_name
+      alias :singular_name :file_name
+
+      def plural_name
+        @plural_name ||= file_name.pluralize
+      end
+
+      def file_path
+        @file_path ||= (class_path + [singular_name]).join('/')
+      end
+
+      def plural_file_path
+        @plural_file_path ||= (class_path + [plural_name]).join('/')
+      end
+
+      def class_name
+        @class_name ||= (class_path + [singular_name]).map! { |m| m.camelize }.join('::')
+      end
+
+      def plural_class_name
+        @plural_class_name ||= (class_path + [plural_name]).map! { |m| m.camelize }.join('::')
+      end
+
+      def plural_class_name
+        @plural_class_name ||= plural_name.camelize
+      end
+
+      def table_name
+        @table_name ||= ([application_name] + [plural_name]).join('_')
+      end
+
+      #def migration_class_name
+      #  @migration_class_name ||= (class_path + [plural_name]).map { |m| m.camelize }.join
+      #end
+
+      def assign_names!(name) #:nodoc:
+        @class_path = name.include?('/') ? name.split('/') : name.split('::')
+        @class_path.map! { |m| m.underscore }
+        @file_name = @class_path.pop.singularize
+      end
+    end
+  end
+end

data/lib/generators/nsweb/controller/controller_generator.rb

@@ -0,0 +1,75 @@
+require 'generators/nsweb'
+
+module Nsweb
+  module Generators
+    class ControllerGenerator < NamedBase
+
+      argument :actions, :type => :array, :default => [],
+        :banner => 'action action'
+
+      class_option :rspec, :desc => 'Use RSpec for test files.', :group => 'Test framework', :type => :boolean
+
+      def initialize(*args, &block)
+        super
+
+        @controller_actions = []
+        actions.each do |action|
+          @controller_actions << action
+          @controller_actions << 'create' if action.eql?( 'new' )
+          @controller_actions << 'update' if action.eql?( 'edit' )
+        end
+        @controller_actions.uniq!
+
+        @controller_actions = all_actions if @controller_actions.empty?
+      end
+
+      def create_controller
+        template 'controller.rb', File.join(engine_path, 'app/controllers',
+                                            "#{plural_file_path}_controller.rb")
+        if test_framework == :rspec
+          template 'tests/rspec.rb', File.join(engine_path, 'spec/controllers',
+                                               "#{plural_file_path}_controller_spec.rb")
+        else
+        end
+        unless options.skip_helper?
+          template 'helper.rb', File.join(engine_path, 'app/helpers',
+                                          "#{plural_file_path}_helper.rb")
+        end
+
+        #controller_actions.each do |action|
+        #  if %w[index show new edit].include?(action)
+        #    template "views/#{action}.html.erb", File.join(engine_path,
+        #                                                   "app/views/#{file_name}/#{action}.html.erb")
+
+
+        #  end
+        #end
+
+        if class_path.length < 0
+          engine_route("resources #{plural_file_name.to_sym.inspect},
+                       :controller => '#{(class_path + [plural_name]).join('/')}")
+        else
+          engine_route("resources #{plural_name.to_sym.inspect}")
+        end
+      end
+
+      protected
+
+      attr_reader :controller_actions
+
+      def controller_methods(dir)
+        controller_actions.map do |action|
+          read_template("#{dir}/#{action}.rb")
+        end.join("\n").strip
+      end
+
+      def read_template(relative_path)
+        ERB.new(File.read(find_in_source_paths(relative_path)), nil, '-').result(binding)
+      end
+
+      def all_actions
+        %w[index show new create edit update destroy]
+      end
+    end
+  end
+end

data/lib/generators/nsweb/controller/templates/actions/create.rb

@@ -0,0 +1,10 @@
+  def create
+    @<%= singular_name %> = <%= class_name %>.new(params[:<%= singular_name %>])
+    if @<%= singular_name %>.save
+      flash[:notice] = "Successfully created <%= file_name.underscore.humanize.downcase %>."
+      redirect_to @<%= singular_name %>
+    else
+      render :action => 'new'
+    end
+  end
+

data/lib/generators/nsweb/controller/templates/actions/destroy.rb

@@ -0,0 +1,7 @@
+    def destroy
+      @<%= singular_name %> = <%= class_name %>.find(params[:id])
+      @<%= singular_name %>.destroy
+      flash[:notice] = "Successfully deleted <%= file_name.humanize.downcase %>."
+      redirect_to <%= plural_name %>_path
+    end
+

data/lib/generators/nsweb/controller/templates/actions/edit.rb

@@ -0,0 +1,4 @@
+    def edit
+      @<%= singular_name %> = <%= class_name %>.find(params[:id])
+    end
+

data/lib/generators/nsweb/controller/templates/actions/index.rb

@@ -0,0 +1,4 @@
+    def index
+      @<%= plural_name %> = <%= class_name %>.all
+    end
+

data/lib/generators/nsweb/controller/templates/actions/new.rb

@@ -0,0 +1,4 @@
+    def new
+      @<%= singular_name %> = <%= class_name %>.new
+    end
+

data/lib/generators/nsweb/controller/templates/actions/show.rb

@@ -0,0 +1,4 @@
+    def show
+      @<%= singular_name %> = <%= class_name %>.find(params[:id])
+    end
+

data/lib/generators/nsweb/controller/templates/actions/update.rb

@@ -0,0 +1,10 @@
+    def update
+      @<%= singular_name %> = <%= class_name %>.find(params[:id])
+      if @<%= singular_name %>.update_attributes(params[:<%= singular_name %>])
+        flash[:notice] = "Successfully updated <%= file_name.humanize.downcase %>."
+        redirect_to @<%= singular_name %>
+      else
+        render :action => 'edit'
+      end
+    end
+

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

@@ -0,0 +1,3 @@
+class <%= plural_class_name %>Controller < ApplicationController
+  <%= controller_methods :actions %>
+end

data/lib/generators/nsweb/controller/templates/helper.rb

@@ -0,0 +1,2 @@
+module <%= plural_class_name %>Helper
+end

data/lib/generators/nsweb/controller/templates/tests/rspec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe <%= class_name %>Controller do
+  pending "add some examples to (or delete) #{__FILE__}"
+end

data/lib/generators/nsweb/controller/templates/views/index.html.erb

@@ -0,0 +1 @@
+<h2>Template for <%= engine_name.titleize %><%= plural_file_name.titleize %>.index</h2>

data/lib/generators/nsweb/engine/USAGE

@@ -0,0 +1,12 @@
+Description:
+    Scaffolds an Engine.  This will generate the necessary directories inside
+    vendor/{application_name}.
+
+Usage:
+    Pass in the name of the Engine, either CamelCased or under_scored, as the
+    only argument.
+
+Examples:
+    rails generate nsweb:engine transfers
+
+        Will create a a Transfers engine inside vendor.

data/lib/generators/nsweb/engine/engine_generator.rb

@@ -0,0 +1,33 @@
+require 'generators/nsweb'
+
+module Nsweb
+  module Generators
+    class EngineGenerator < Base
+
+      attr_accessor :engine_name
+
+      def initialize(*args, &block)
+        super
+      end
+
+      def create_engine
+        template 'engine.rb', File.join(engine_path, 'lib', "#{engine_file_name}.rb")
+      end
+
+      def create_routes
+        template 'routes.rb', File.join(engine_path, 'config/routes.rb')
+      end
+
+      protected
+
+      def engine_file_name
+        @engine_file_name ||= engine_name.underscore
+      end
+
+      def engine_class_name
+        @engine_class_name ||= engine_name.camelize
+      end
+
+    end
+  end
+end

data/lib/generators/nsweb/engine/templates/engine.rb

@@ -0,0 +1,22 @@
+require 'rails/all'
+
+module <%= application_name %>
+  module <%= engine_class_name %>
+    class << self
+      def root
+        @root ||= File.dirname(File.expand_path(__FILE__))
+      end
+    end
+
+    class Engine < Rails::Engine
+
+      config.after_initialize do |app|
+        <%= application_name %>::Plugin.register do |plugin|
+          plugin.name = '<%= engine_file_name %>'
+          plugin.title = '<%= engine_class_name %>'
+          plugin.version = %q{0.0.1}
+        end
+      end
+    end
+  end
+end

data/lib/generators/nsweb/engine/templates/routes.rb

@@ -0,0 +1,2 @@
+<%= application_name %>::Application.routes.draw do
+end

data/lib/generators/nsweb/model/model_generator.rb

@@ -0,0 +1,53 @@
+require 'generators/nsweb'
+require 'rails/generators/migration'
+require 'rails/generators/generated_attribute'
+
+module Nsweb
+  module Generators
+    class ModelGenerator < NamedBase
+      include Rails::Generators::Migration
+
+      argument :attributes, :type => :array, :default => [], :banner => 'field:type field:type'
+
+      class_option :skip_migration, :desc => 'Don\'t generate a migration file for model.', :type => :boolean
+      class_option :rspec, :desc => 'Use RSpec for test files.', :group => 'Test framework', :type => :boolean
+
+      def initialize(*args, &block)
+        super
+        @model_attributes = []
+        attributes.each do |attr|
+          @model_attributes << Rails::Generators::GeneratedAttribute.new(*attr.split(':'))
+        end
+      end
+
+      def create_model
+        template 'model.rb', File.join(engine_path, 'app/models', "#{file_path}.rb")
+        if test_framework == :rspec
+          template 'tests/rspec/model.rb', File.join(engine_path, 'spec/models',
+                                                     "#{file_path}_spec.rb")
+        else
+          template "tests/#{test_framework}/model.rb", File.join(engine_path, "test/unit/#{singular_name}_test.rb")
+                                                                
+        end
+      end
+
+      def create_migration
+        unless options.skip_migration?
+          migration_template 'migration.rb', "db/migrate/create_#{table_name}.rb"
+        end
+      end
+
+      def self.next_migration_number(dirname) #:nodoc:
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime( '%Y%m%d%H%M%S' )
+        else
+          "#.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+
+      protected
+
+      attr_reader :model_attributes
+    end
+  end
+end

data/lib/generators/nsweb/model/templates/migration.rb

@@ -0,0 +1,15 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= table_name %> do |t|
+    <%- model_attributes.each do |attribute| -%>
+      t.<%= attribute.type %> :<%= attribute.name %>
+    <%- end -%>
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :<%= table_name %>
+  end
+end

data/lib/generators/nsweb/model/templates/model.rb

@@ -0,0 +1,3 @@
+class <%= class_name %> < ActiveRecord::Base
+ include <%= application_name.camelize %>::Model
+end

data/lib/generators/nsweb/model/templates/tests/rspec/model.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe <%= class_name %> do
+  pending "add some examples to (or delete) #{__FILE__}"
+end

data/lib/generators/nsweb/model/templates/tests/testunit/model.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class <%= class_name %>Test < ActiveSupport::TestCase
+  def test_should_be_valid
+    assert <%= class_name %>.new.valid?
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification 
+name: nsweb-generators
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Josh Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-10 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 2
+        - 0
+        - 1
+        version: 2.0.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 9
+        - 2
+        version: 0.9.2
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 3
+        - 0
+        - 3
+        version: 3.0.3
+  type: :runtime
+  version_requirements: *id003
+description: Generators for Nsweb engines/models/controllers
+email: jwilliams@shareone.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- features/nsweb_controller.feature
+- features/nsweb_engine.feature
+- features/nsweb_model.feature
+- features/step_definitions/common_steps.rb
+- features/step_definitions/setup_steps.rb
+- lib/generators/nsweb.rb
+- lib/generators/nsweb/controller/controller_generator.rb
+- lib/generators/nsweb/controller/templates/actions/create.rb
+- lib/generators/nsweb/controller/templates/actions/destroy.rb
+- lib/generators/nsweb/controller/templates/actions/edit.rb
+- lib/generators/nsweb/controller/templates/actions/index.rb
+- lib/generators/nsweb/controller/templates/actions/new.rb
+- lib/generators/nsweb/controller/templates/actions/show.rb
+- lib/generators/nsweb/controller/templates/actions/update.rb
+- lib/generators/nsweb/controller/templates/controller.rb
+- lib/generators/nsweb/controller/templates/helper.rb
+- lib/generators/nsweb/controller/templates/tests/rspec.rb
+- lib/generators/nsweb/controller/templates/views/index.html.erb
+- lib/generators/nsweb/engine/USAGE
+- lib/generators/nsweb/engine/engine_generator.rb
+- lib/generators/nsweb/engine/templates/engine.rb
+- lib/generators/nsweb/engine/templates/routes.rb
+- lib/generators/nsweb/model/model_generator.rb
+- lib/generators/nsweb/model/templates/migration.rb
+- lib/generators/nsweb/model/templates/model.rb
+- lib/generators/nsweb/model/templates/tests/rspec/model.rb
+- lib/generators/nsweb/model/templates/tests/testunit/model.rb
+- lib/generators/nsweb/scaffold/scaffold_generator.rb
+has_rdoc: true
+homepage: http://projects.hbtesting.org
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Generators for Nsweb
+test_files: []
+