bpokosh-nifty-generators 0.1.3

data/CHANGELOG

@@ -0,0 +1,19 @@
+*0.1.3* (June 20th, 2008)
+
+* using _url in controllers instead of _path
+
+* improving the nifty_config default example YAML file
+
+*0.1.2* (May 16th, 2008)
+
+* mentioning nifty_layout in nifty_scaffold generator
+
+* adding nifty_config generator
+
+*0.1.1* (May 9th, 2008)
+
+* adding tests and specs to scaffold generator
+
+*0.1.0* (May 8th, 2008)
+
+* initial release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Ryan Bates
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest

@@ -0,0 +1,57 @@
+CHANGELOG
+lib/nifty_generators.rb
+LICENSE
+Manifest
+rails_generators/nifty_config/nifty_config_generator.rb
+rails_generators/nifty_config/templates/config.yml
+rails_generators/nifty_config/templates/load_config.rb
+rails_generators/nifty_config/USAGE
+rails_generators/nifty_layout/nifty_layout_generator.rb
+rails_generators/nifty_layout/templates/helper.rb
+rails_generators/nifty_layout/templates/layout.html.erb
+rails_generators/nifty_layout/templates/stylesheet.css
+rails_generators/nifty_layout/USAGE
+rails_generators/nifty_scaffold/nifty_scaffold_generator.rb
+rails_generators/nifty_scaffold/templates/action_specs/create.rb
+rails_generators/nifty_scaffold/templates/action_specs/destroy.rb
+rails_generators/nifty_scaffold/templates/action_specs/edit.rb
+rails_generators/nifty_scaffold/templates/action_specs/index.rb
+rails_generators/nifty_scaffold/templates/action_specs/new.rb
+rails_generators/nifty_scaffold/templates/action_specs/show.rb
+rails_generators/nifty_scaffold/templates/action_specs/update.rb
+rails_generators/nifty_scaffold/templates/action_tests/create.rb
+rails_generators/nifty_scaffold/templates/action_tests/destroy.rb
+rails_generators/nifty_scaffold/templates/action_tests/edit.rb
+rails_generators/nifty_scaffold/templates/action_tests/index.rb
+rails_generators/nifty_scaffold/templates/action_tests/new.rb
+rails_generators/nifty_scaffold/templates/action_tests/show.rb
+rails_generators/nifty_scaffold/templates/action_tests/update.rb
+rails_generators/nifty_scaffold/templates/actions/create.rb
+rails_generators/nifty_scaffold/templates/actions/destroy.rb
+rails_generators/nifty_scaffold/templates/actions/edit.rb
+rails_generators/nifty_scaffold/templates/actions/index.rb
+rails_generators/nifty_scaffold/templates/actions/new.rb
+rails_generators/nifty_scaffold/templates/actions/show.rb
+rails_generators/nifty_scaffold/templates/actions/update.rb
+rails_generators/nifty_scaffold/templates/controller.rb
+rails_generators/nifty_scaffold/templates/controller_spec.rb
+rails_generators/nifty_scaffold/templates/controller_test.rb
+rails_generators/nifty_scaffold/templates/fixtures.yml
+rails_generators/nifty_scaffold/templates/helper.rb
+rails_generators/nifty_scaffold/templates/migration.rb
+rails_generators/nifty_scaffold/templates/model.rb
+rails_generators/nifty_scaffold/templates/model_spec.rb
+rails_generators/nifty_scaffold/templates/model_test.rb
+rails_generators/nifty_scaffold/templates/views/_form.html.erb
+rails_generators/nifty_scaffold/templates/views/edit.html.erb
+rails_generators/nifty_scaffold/templates/views/index.html.erb
+rails_generators/nifty_scaffold/templates/views/new.html.erb
+rails_generators/nifty_scaffold/templates/views/show.html.erb
+rails_generators/nifty_scaffold/USAGE
+README
+tasks/deployment.rake
+test/test_helper.rb
+test/test_nifty_config_generator.rb
+test/test_nifty_layout_generator.rb
+test/test_nifty_scaffold_generator.rb
+TODO

data/README

@@ -0,0 +1,73 @@
+= Nifty Generators
+
+A collection of useful Rails generator scripts by Ryan Bates.
+
+This fork converts the views from ERb to HAML.
+
+
+== Install
+
+  gem install ryanb-nifty-generators --source=http://gems.github.com
+
+  
+== Usage
+
+Once you install the gem, the generators will be available to all Rails
+applications on your system. If you run script/generate without any
+additional arguments you should see the available generators listed.
+
+To run the generator, go to your rails project directory and call it
+using the script/generate or script/destroy command.
+
+  script/generate nifty_scaffold Recipe name:string index new
+
+  
+== Included Generators
+
+* nifty_layout: generates generic layout, stylesheet, and helper files.
+* nifty_scaffold: generates a controller and optional model/migration.
+* nifty_config: generates a config YAML file and loader.
+
+Run the command with the --help option to learn more.
+
+  script/generate nifty_layout --help
+
+
+== Troubleshooting
+
+*I get "undefined method 'title'" error for nifty_scaffold.*
+
+Try running nifty_layout too, that will generate this helper method. Or
+you can just change the templates to whatever approach you prefer for
+setting the title.
+
+
+*Forms don't work for nifty_scaffold.*
+
+Try restarting your development server. Sometimes it doesn't detect the
+change in the routing.
+
+
+*The tests/specs don't work for nifty_scaffold.*
+
+Make sure you have mocha installed and require it in your spec/test helper.
+
+  gem install mocha
+  
+  # in spec_helper.rb
+  config.mock_with :mocha
+  
+  # in test_helper.rb
+  require 'mocha'
+
+Also, make sure you're using edge rails (or 2.1 when released) as some methods require that.
+
+
+== Development
+
+This project can be found on github at the following URL.
+
+http://github.com/ryanb/nifty-generators/
+
+If you wish the generators behaved differently, please consider
+forking the project and modifying to your heart's content.

data/TODO

@@ -0,0 +1,6 @@
+
+Nifty Scaffold Generator
+  - add some validation for attributes/action names
+
+Nifty Config Generator
+  - make it easier to specify non environment specific configs

data/lib/nifty_generators.rb

@@ -0,0 +1,3 @@
+module NiftyGenerators
+  # nothing to see here, the real action is under rails_generators
+end

data/nifty-generators.gemspec

@@ -0,0 +1,51 @@
+
+# Gem::Specification for Nifty-generators-0.1.3
+# Originally generated by Echoe
+
+Gem::Specification.new do |s|
+  s.name = %q{nifty-generators}
+  s.version = "0.1.3"
+
+  s.specification_version = 2 if s.respond_to? :specification_version=
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ryan Bates"]
+  s.date = %q{2008-06-20}
+  s.description = %q{A collection of useful generator scripts for Rails.}
+  s.email = %q{ryan (at) railscasts (dot) com}
+  s.extra_rdoc_files = ["CHANGELOG", "lib/nifty_generators.rb", "LICENSE", "README", "tasks/deployment.rake", "TODO"]
+  s.files = ["CHANGELOG", "lib/nifty_generators.rb", "LICENSE", "Manifest", "rails_generators/nifty_config/nifty_config_generator.rb", "rails_generators/nifty_config/templates/config.yml", "rails_generators/nifty_config/templates/load_config.rb", "rails_generators/nifty_config/USAGE", "rails_generators/nifty_layout/nifty_layout_generator.rb", "rails_generators/nifty_layout/templates/helper.rb", "rails_generators/nifty_layout/templates/layout.html.erb", "rails_generators/nifty_layout/templates/stylesheet.css", "rails_generators/nifty_layout/USAGE", "rails_generators/nifty_scaffold/nifty_scaffold_generator.rb", "rails_generators/nifty_scaffold/templates/action_specs/create.rb", "rails_generators/nifty_scaffold/templates/action_specs/destroy.rb", "rails_generators/nifty_scaffold/templates/action_specs/edit.rb", "rails_generators/nifty_scaffold/templates/action_specs/index.rb", "rails_generators/nifty_scaffold/templates/action_specs/new.rb", "rails_generators/nifty_scaffold/templates/action_specs/show.rb", "rails_generators/nifty_scaffold/templates/action_specs/update.rb", "rails_generators/nifty_scaffold/templates/action_tests/create.rb", "rails_generators/nifty_scaffold/templates/action_tests/destroy.rb", "rails_generators/nifty_scaffold/templates/action_tests/edit.rb", "rails_generators/nifty_scaffold/templates/action_tests/index.rb", "rails_generators/nifty_scaffold/templates/action_tests/new.rb", "rails_generators/nifty_scaffold/templates/action_tests/show.rb", "rails_generators/nifty_scaffold/templates/action_tests/update.rb", "rails_generators/nifty_scaffold/templates/actions/create.rb", "rails_generators/nifty_scaffold/templates/actions/destroy.rb", "rails_generators/nifty_scaffold/templates/actions/edit.rb", "rails_generators/nifty_scaffold/templates/actions/index.rb", "rails_generators/nifty_scaffold/templates/actions/new.rb", "rails_generators/nifty_scaffold/templates/actions/show.rb", "rails_generators/nifty_scaffold/templates/actions/update.rb", "rails_generators/nifty_scaffold/templates/controller.rb", "rails_generators/nifty_scaffold/templates/controller_spec.rb", "rails_generators/nifty_scaffold/templates/controller_test.rb", "rails_generators/nifty_scaffold/templates/fixtures.yml", "rails_generators/nifty_scaffold/templates/helper.rb", "rails_generators/nifty_scaffold/templates/migration.rb", "rails_generators/nifty_scaffold/templates/model.rb", "rails_generators/nifty_scaffold/templates/model_spec.rb", "rails_generators/nifty_scaffold/templates/model_test.rb", "rails_generators/nifty_scaffold/templates/views/_form.html.erb", "rails_generators/nifty_scaffold/templates/views/edit.html.erb", "rails_generators/nifty_scaffold/templates/views/index.html.erb", "rails_generators/nifty_scaffold/templates/views/new.html.erb", "rails_generators/nifty_scaffold/templates/views/show.html.erb", "rails_generators/nifty_scaffold/USAGE", "README", "tasks/deployment.rake", "test/test_helper.rb", "test/test_nifty_config_generator.rb", "test/test_nifty_layout_generator.rb", "test/test_nifty_scaffold_generator.rb", "TODO", "nifty-generators.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/ryanb/nifty-generators}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Nifty-generators", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{nifty-generators}
+  s.rubygems_version = %q{1.0.0}
+  s.summary = %q{A collection of useful generator scripts for Rails.}
+  s.test_files = ["test/test_helper.rb", "test/test_nifty_config_generator.rb", "test/test_nifty_layout_generator.rb", "test/test_nifty_scaffold_generator.rb"]
+end
+
+
+# # Original Rakefile source (requires the Echoe gem):
+# 
+# require 'rubygems'
+# require 'rake'
+#  
+# begin
+#   require 'echoe'
+# 
+#   Echoe.new('nifty-generators', '0.1.3') do |p|
+#     p.summary        = "A collection of useful generator scripts for Rails."
+#     p.description    = "A collection of useful generator scripts for Rails."
+#     p.url            = "http://github.com/ryanb/nifty-generators"
+#     p.author         = 'Ryan Bates'
+#     p.email          = "ryan (at) railscasts (dot) com"
+#     p.ignore_pattern = ["script/*", "*.gemspec"]
+#   end
+# 
+# rescue LoadError => boom
+#   puts "You are missing a dependency required for meta-operations on this gem."
+#   puts "#{boom.to_s.capitalize}."
+# end
+# 
+# Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/rails_generators/nifty_config/USAGE

@@ -0,0 +1,23 @@
+Description:
+    The nifty_config generator creates YAML file in your config
+    directory and an initializer to load this config. The config has a
+    separate section for each environment. This is a great place to put
+    any config settings you don't want in your app.
+  
+    The config is loaded into a constant called APP_CONFIG by default,
+    this changes depending on the name you choose to pass the generator.
+    Use this constant to access the config settings like this.
+  
+    APP_CONFIG[:some_setting]
+
+
+Examples:
+    script/generate nifty_config
+
+        Config:      config/app_config.yml
+        Initializer: config/initializers/load_app_config.rb
+
+    script/generate nifty_config passwords
+
+        Config:      config/passwords_config.yml
+        Initializer: config/initializers/load_passwords_config.rb

data/rails_generators/nifty_config/nifty_config_generator.rb

@@ -0,0 +1,32 @@
+class NiftyConfigGenerator < Rails::Generator::Base
+  def initialize(runtime_args, runtime_options = {})
+    super
+    @name = @args.first || 'app'
+  end
+  
+  def manifest
+    record do |m|
+      m.directory 'config/initializers'
+
+      m.template "load_config.rb", "config/initializers/load_#{file_name}_config.rb"
+      m.file     "config.yml",  "config/#{file_name}_config.yml"
+    end
+  end
+  
+  def file_name
+    @name.underscore
+  end
+  
+  def constant_name
+    @name.underscore.upcase
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates config and loader files.
+
+USAGE: #{$0} #{spec.name} [config_name]
+EOS
+    end
+end

data/rails_generators/nifty_config/templates/config.yml

@@ -0,0 +1,8 @@
+development:
+  domain: localhost:3000
+
+test:
+  domain: test.host
+
+production:
+  domain: example.com

data/rails_generators/nifty_config/templates/load_config.rb

@@ -0,0 +1,2 @@
+raw_config = File.read(RAILS_ROOT + "/config/<%= file_name %>_config.yml")
+<%= constant_name %>_CONFIG = YAML.load(raw_config)[RAILS_ENV].symbolize_keys

data/rails_generators/nifty_layout/USAGE

@@ -0,0 +1,25 @@
+Description:
+  The nifty_layout generator creates a basic layout, stylesheet and
+  helper which will give some structure to a starting Rails app.
+  
+  The generator takes one argument which will be the name of the
+	layout and stylesheet files. If no argument is passed then it defaults
+	to "application".
+  
+  The helper module includes some methods which can be called in any
+  template or partial to set variables to be used in the layout, such as
+  page title and javascript/stylesheet includes.
+
+Examples:
+    script/generate nifty_layout
+
+        Layout:     app/views/layouts/application.html.erb
+        Stylesheet: public/stylesheets/application.css
+        Helper:     app/helpers/layout_helper.rb
+
+
+    script/generate nifty_layout admin
+
+        Layout:     app/views/layouts/admin.html.erb
+        Stylesheet: public/stylesheets/admin.css
+        Helper:     app/helpers/layout_helper.rb

data/rails_generators/nifty_layout/nifty_layout_generator.rb

@@ -0,0 +1,31 @@
+class NiftyLayoutGenerator < Rails::Generator::Base
+  def initialize(runtime_args, runtime_options = {})
+    super
+    @name = @args.first || 'application'
+  end
+  
+  def manifest
+    record do |m|
+      m.directory 'app/views/layouts'
+      m.directory 'public/stylesheets'
+      m.directory 'app/helpers'
+
+      m.template "layout.html.haml", "app/views/layouts/#{file_name}.html.haml"
+      m.file     "stylesheet.sass",  "public/stylesheets/sass/#{file_name}.sass"
+      m.file     "helper.rb",       "app/helpers/layout_helper.rb"
+    end
+  end
+  
+  def file_name
+    @name.underscore
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates generic layout, stylesheet, and helper files.
+
+USAGE: #{$0} #{spec.name} [layout_name]
+EOS
+    end
+end

data/rails_generators/nifty_layout/templates/helper.rb

@@ -0,0 +1,23 @@
+# These helper methods can be called in your template to set variables to be used in the layout
+# This module should be included in all views globally,
+# to do so you may need to add this line to your ApplicationController
+#   helper :layout
+module LayoutHelper
+  def title(page_title, show_title = true)
+    @content_for_title = page_title.to_s
+    @show_title = show_title
+  end
+  
+  def show_title?
+    @show_title
+  end
+  
+  def stylesheet(*args)
+    content_for(:head) { stylesheet_link_tag(*args.map(&:to_s)) }
+  end
+  
+  def javascript(*args)
+    args = args.map { |arg| arg == :defaults ? arg : arg.to_s }
+    content_for(:head) { javascript_include_tag(*args) }
+  end
+end

data/rails_generators/nifty_scaffold/USAGE

@@ -0,0 +1,51 @@
+Description:
+    Scaffolds an entire resource, from model and migration to controller and
+    views. The resource is ready to use as a starting point for your restful,
+    resource-oriented application. Tests or specs are also generated depending
+    on if you have a "spec" directory or not.
+    
+    IMPORTANT: This generator uses the "title" helper method which is generated
+    by the nifty_layout generator. You may want to run that generator first.
+
+Usage:
+    Pass the name of the model, either CamelCased or under_scored, as the first
+    argument, and an optional list of attribute pairs and controller actions.
+    
+    If no controller actions are specified, they will default to index, show,
+    new, create, edit, update, and destroy.
+    
+    IMPORTANT: If no attribute pairs are specified, no model will be generated.
+    It will try to determine the attributes from an existing model.
+
+    Attribute pairs are column_name:sql_type arguments specifying the
+    model's attributes. Timestamps are added by default, so you don't have to
+    specify them by hand as 'created_at:datetime updated_at:datetime'.
+
+    For example, `nifty_scaffold post name:string content:text hidden:boolean`
+    gives you a model with those three attributes, a controller that handles
+    the create/show/update/destroy, forms to create and edit your posts, and
+    an index that lists them all, as well as a map.resources :posts
+    declaration in config/routes.rb.
+    
+    Adding an "!" in the mix of arguments will invert the passed controller
+    actions. This will include all 7 controller actitons except the ones
+    mentioned. This option doesn't effect model attributes.
+
+Examples:
+    script/generate nifty_scaffold post
+        
+        Will create a controller called "posts" it will contain all seven
+        CRUD actions along with the views. A model will NOT be created,
+        instead it will look for an existing model and use those attributes.
+    
+    script/generate nifty_scaffold post name:string content:text index new edit
+        
+        Will create a Post model and migration file with the name and content
+        attributes. It will also create a controller with index, new, create,
+        edit, and update actions. Notice the create and update actions are
+        added automatically with new and edit.
+    
+    script/generate nifty_scaffold post ! show new
+        
+        Creates a posts controller (no model) with index, edit, update, and
+        destroy actions.