somatics3-generators 0.0.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 tkwong
+
+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/README.rdoc

@@ -0,0 +1,17 @@
+= somatics3-generators
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 tkwong. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,60 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "somatics3-generators"
+    gem.summary = %Q{Somatics - Adminable Resource generators}
+    gem.description = %Q{Somatics 3 generators is used to generate a resource with skeleton admin panel}
+    gem.email = "tkwong@inspiresynergy.com"
+    gem.homepage = "http://github.com/inspiresynergy/somatics3-generators"
+    gem.authors = ["Benjamin Wong"]
+    # gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.rdoc_options += FileList['lib/**/templates/*'].to_a.collect{|f| "--exclude=#{f}" }
+    # gem.rdoc_options << "--exclude='lib/**/templates/*'"
+    gem.rubyforge_project = 'somatics3'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = "rdoc"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "somatics3-generators #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.exclude('lib/**/templates/*')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/bin/somatics

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+template_path = File.expand_path(File.dirname(__FILE__) + '/../templates')
+
+
+# require 'somatics'
+
+args = ARGV.dup
+ARGV.clear
+# path = args.shift.strip rescue '.'
+
+# a = File.expand_path(path)
+template = File.join(template_path,'somatics.rb')
+
+# puts "#{path} #{a} #{args.join(',')} #{template}"
+system "rails #{args.join(' ')} -m #{template}"
+
+exit

data/bin/somatify

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+template_path = File.expand_path(File.dirname(__FILE__) + '/../templates')
+
+
+# require 'somatics'
+
+args = ARGV.dup
+ARGV.clear
+path = args.shift.strip rescue '.'
+
+a = File.expand_path(path)
+template = File.join(template_path,'somatics.rb')
+
+# puts "#{path} #{a} #{args.join(',')} #{template}"
+system "rake rails:template LOCATION=#{template}"
+
+exit

data/lib/generators/somatics/authenticated/authenticated_generator.rb

@@ -0,0 +1,220 @@
+require 'generators/somatics'
+require 'rails/generators/named_base'
+require 'rails/generators/resource_helpers'
+require 'digest/sha1'
+require 'rails/generators/migration'
+        
+module Somatics
+  module Generators
+    class AuthenticatedGenerator < Rails::Generators::NamedBase
+      extend TemplatePath
+      include Rails::Generators::ResourceHelpers
+      include Rails::Generators::Migration
+      
+      argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+      class_option :namespace, :banner => "NAME", :type => :string, :default => ''
+      
+      class_option :skip_routes,          :type => :boolean, :desc => "Don't generate a resource line in config/routes.rb."
+      class_option :skip_migration,       :type => :boolean, :desc => "Don't generate a migration file for this model."
+      class_option :aasm,                 :type => :boolean, :desc => "Works the same as stateful but uses the updated aasm gem"
+      class_option :stateful,             :type => :boolean, :desc => "Builds in support for acts_as_state_machine and generatesactivation code."
+      class_option :rspec,                :type => :boolean, :desc => "Generate RSpec tests and Stories in place of standard rails tests."
+      class_option :old_passwords,        :type => :boolean, :desc => "Use the older password scheme"
+      class_option :include_activation,   :type => :boolean, :desc => "Skip the code for a ActionMailer and its respective Activation Code through email"
+      class_option :dump_generator_attrs, :type => :boolean, :desc => "Dump Generator Attrs"
+      
+
+      def create_model_files
+        template 'model.rb', File.join('app/models', class_path, "#{ file_name }.rb")
+        if options.include_activation?
+          # Check for class naming collisions.
+          class_collisions  "#{class_name}Mailer", "#{class_name}MailerTest", "#{class_name}Observer"
+          template "mailer.rb", File.join('app/mailers', class_path, "#{ file_name }_mailer.rb")
+          template "observer.rb", File.join('app/models', class_path, "#{ file_name }_observer.rb")
+        end
+      end
+      
+      def add_model_and_migration
+        template 'model.rb', "app/model/#{singular_name}.rb"
+        unless options.skip_migration?
+          migration_template 'migration.rb', "db/migrate/create_#{ migration_file_name }.rb"
+        end
+      end
+      
+      def dump_generator_attribute_names
+        generator_attribute_names = [
+          :table_name,
+          :file_name,
+          :class_name,
+          :sessions_controller_name,
+          :sessions_controller_class_path,
+          :sessions_controller_file_path,
+          # :sessions_controller_class_nesting,
+          # :sessions_controller_class_nesting_depth,
+          :sessions_controller_class_name,
+          :sessions_controller_singular_name,
+          :sessions_controller_plural_name,
+          :sessions_controller_routing_name,                 # new_session_path
+          :sessions_controller_routing_path,                 # /session/new
+          :sessions_controller_controller_name,              # sessions
+          :sessions_controller_file_name,
+          :sessions_controller_table_name, 
+          :controller_name,
+          :controller_class_path,
+          :controller_file_path,
+          # :controller_class_nesting,
+          # :controller_class_nesting_depth,
+          # :controller_class_name,
+          # :controller_singular_name,
+          :controller_plural_name,
+          :controller_routing_name,           # new_user_path
+          # :controller_routing_path,           # /users/new
+          # :controller_controller_name,        # users
+          # :controller_file_name,  
+          # :controller_singular_name,
+          # :controller_table_name, 
+          # :controller_plural_name,
+        ]
+
+        generator_attribute_names.each do |attr|
+          puts "%-40s %s" % ["#{attr}:", self.send(attr.to_s)]  # instance_variable_get("@#{attr.to_s}"
+        end
+
+      end
+      
+      # rails g authenticated FoonParent::Foon SporkParent::Spork -p --force --rspec --dump-generator-attrs
+      # table_name:                              foon_parent_foons
+      # file_name:                               foon
+      # class_name:                              FoonParent::Foon
+      # controller_name:                         SporkParent::Sporks
+      # controller_class_path:                   spork_parent
+      # controller_file_path:                    spork_parent/sporks
+      # controller_class_nesting:                SporkParent
+      # controller_class_nesting_depth:          1
+      # controller_class_name:                   SporkParent::Sporks
+      # controller_singular_name:                spork
+      # controller_plural_name:                  sporks
+      # controller_routing_name:                 spork
+      # controller_routing_path:                 spork_parent/spork
+      # controller_controller_name:              sporks
+      # controller_file_name:                    sporks
+      # controller_table_name:                   sporks
+      # controller_plural_name:                  sporks
+      # model_controller_name:                   FoonParent::Foons
+      # model_controller_class_path:             foon_parent
+      # model_controller_file_path:              foon_parent/foons
+      # model_controller_class_nesting:          FoonParent
+      # model_controller_class_nesting_depth:    1
+      # model_controller_class_name:             FoonParent::Foons
+      # model_controller_singular_name:          foons
+      # model_controller_plural_name:            foons
+      # model_controller_routing_name:           foon_parent_foons
+      # model_controller_routing_path:           foon_parent/foons
+      # model_controller_controller_name:        foons
+      # model_controller_file_name:              foons
+      # model_controller_singular_name:          foons
+      # model_controller_table_name:             foons
+      # model_controller_plural_name:            foons
+      
+      
+      protected 
+      
+      def namespace_class
+        # options[:namespace].classify
+      end
+      
+      def namespace_name
+        # options[:namespace].underscore
+      end
+      
+      def sessions_controller_name
+        file_name + '_sessions'
+      end
+      
+      def sessions_controller_class_path
+        class_path
+      end
+      
+      def sessions_controller_file_path
+        controller_file_path
+      end
+      
+      def sessions_controller_singular_name
+        controller_name
+      end
+      
+      def sessions_controller_plural_name
+        controller_name
+      end
+      
+      def sessions_controller_routing_name  
+        singular_name
+      end      
+      
+      def sessions_controller_routing_path
+        sessions_controller_file_path.singularize
+      end
+      
+      def sessions_controller_class_name
+        class_name + 'Session'
+      end
+      
+      def sessions_controller_controller_name
+        controller_plural_name
+      end
+      
+      def sessions_controller_file_name
+        file_name + '_session'
+      end
+      
+      def sessions_controller_table_name
+        controller_plural_name
+      end
+      
+      def controller_plural_name
+        plural_name
+      end
+      
+      def controller_routing_name
+        controller_plural_name
+      end
+      
+      def migration_name
+        "Create#{ class_name.pluralize.gsub(/::/, '') }"
+      end
+
+      def migration_file_name
+        "#{ file_path.gsub(/\//, '_').pluralize }"
+      end
+      
+      #
+      # Implement the required interface for Rails::Generators::Migration.
+      # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
+      #
+      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
+      
+      #
+      # !! These must match the corresponding routines in by_password.rb !!
+      #
+      def secure_digest(*args)
+        Digest::SHA1.hexdigest(args.flatten.join('--'))
+      end
+      def make_token
+        secure_digest(Time.now, (1..10).map{ rand.to_s })
+      end
+      def password_digest(password, salt)
+        digest = $rest_auth_site_key_from_generator
+        $rest_auth_digest_stretches_from_generator.times do
+          digest = secure_digest(digest, salt, password, $rest_auth_site_key_from_generator)
+        end
+        digest
+      end
+    end
+  end
+end

data/lib/generators/somatics/authenticated/templates/mailer.rb

@@ -0,0 +1,25 @@
+class <%= class_name %>Mailer < ActionMailer::Base
+  def signup_notification(<%= file_name %>)
+    setup_email(<%= file_name %>)
+    @subject    += 'Please activate your new account'
+  <% if options[:include_activation] %>
+    @body[:url]  = "http://YOURSITE/activate/#{<%= file_name %>.activation_code}"
+  <% else %>
+    @body[:url]  = "http://YOURSITE/login/" <% end %>
+  end
+  
+  def activation(<%= file_name %>)
+    setup_email(<%= file_name %>)
+    @subject    += 'Your account has been activated!'
+    @body[:url]  = "http://YOURSITE/"
+  end
+  
+  protected
+    def setup_email(<%= file_name %>)
+      @recipients  = "#{<%= file_name %>.email}"
+      @from        = "ADMINEMAIL"
+      @subject     = "[YOURSITE] "
+      @sent_on     = Time.now
+      @body[:<%= file_name %>] = <%= file_name %>
+    end
+end

data/lib/generators/somatics/authenticated/templates/migration.rb

@@ -0,0 +1,26 @@
+class <%= migration_name %> < ActiveRecord::Migration
+  def self.up
+    create_table "<%= table_name %>", :force => true do |t|
+      t.column :login,                     :string, :limit => 40
+      t.column :name,                      :string, :limit => 100, :default => '', :null => true
+      t.column :email,                     :string, :limit => 100
+      t.column :crypted_password,          :string, :limit => 40
+      t.column :salt,                      :string, :limit => 40
+      t.column :created_at,                :datetime
+      t.column :updated_at,                :datetime
+      t.column :remember_token,            :string, :limit => 40
+      t.column :remember_token_expires_at, :datetime
+<% if options[:include_activation] -%>
+      t.column :activation_code,           :string, :limit => 40
+      t.column :activated_at,              :datetime<% end %>
+<% for attribute in attributes -%>
+      t.<%= attribute.type %> :<%= attribute.name %>
+<% end -%>
+    end
+    add_index :<%= table_name %>, :login, :unique => true
+  end
+
+  def self.down
+    drop_table "<%= table_name %>"
+  end
+end

data/lib/generators/somatics/authenticated/templates/model.rb

@@ -0,0 +1,83 @@
+require 'digest/sha1'
+
+class <%= class_name %> < ActiveRecord::Base
+  include Authentication
+  include Authentication::ByPassword
+  include Authentication::ByCookieToken
+<% if options[:aasm] -%>
+  include Authorization::AasmRoles
+<% elsif options[:stateful] -%>
+  include Authorization::StatefulRoles<% end %>
+  validates_presence_of     :login
+  validates_length_of       :login,    :within => 3..40
+  validates_uniqueness_of   :login
+  validates_format_of       :login,    :with => Authentication.login_regex, :message => Authentication.bad_login_message
+
+  validates_format_of       :name,     :with => Authentication.name_regex,  :message => Authentication.bad_name_message, :allow_nil => true
+  validates_length_of       :name,     :maximum => 100
+
+  validates_presence_of     :email
+  validates_length_of       :email,    :within => 6..100 #r@a.wk
+  validates_uniqueness_of   :email
+  validates_format_of       :email,    :with => Authentication.email_regex, :message => Authentication.bad_email_message
+
+  <% if options[:include_activation] && !options[:stateful] %>before_create :make_activation_code <% end %>
+
+  # HACK HACK HACK -- how to do attr_accessible from here?
+  # prevents a user from submitting a crafted form that bypasses activation
+  # anything else you want your user to change should be added here.
+  attr_accessible :login, :email, :name, :password, :password_confirmation
+
+<% if options[:include_activation] && !options[:stateful] %>
+  # Activates the user in the database.
+  def activate!
+    @activated = true
+    self.activated_at = Time.now.utc
+    self.activation_code = nil
+    save(false)
+  end
+
+  # Returns true if the user has just been activated.
+  def recently_activated?
+    @activated
+  end
+
+  def active?
+    # the existence of an activation code means they have not activated yet
+    activation_code.nil?
+  end<% end %>
+
+  # Authenticates a user by their login name and unencrypted password.  Returns the user or nil.
+  #
+  # uff.  this is really an authorization, not authentication routine.  
+  # We really need a Dispatch Chain here or something.
+  # This will also let us return a human error message.
+  #
+  def self.authenticate(login, password)
+    return nil if login.blank? || password.blank?
+    u = <% if    options[:stateful]           %>find_in_state :first, :active, :conditions => {:login => login.downcase}<%
+           elsif options[:include_activation] %>find :first, :conditions => ['login = ? and activated_at IS NOT NULL', login]<%
+           else %>find_by_login(login.downcase)<% end %> # need to get the salt
+    u && u.authenticated?(password) ? u : nil
+  end
+
+  def login=(value)
+    write_attribute :login, (value ? value.downcase : nil)
+  end
+
+  def email=(value)
+    write_attribute :email, (value ? value.downcase : nil)
+  end
+
+  protected
+    
+<% if options[:include_activation] -%>
+    def make_activation_code
+  <% if options[:stateful] -%>
+      self.deleted_at = nil
+  <% end -%>
+      self.activation_code = self.class.make_token
+    end
+<% end %>
+
+end

data/lib/generators/somatics/authenticated/templates/observer.rb

@@ -0,0 +1,11 @@
+class <%= class_name %>Observer < ActiveRecord::Observer
+  def after_create(<%= file_name %>)
+    <%= class_name %>Mailer.deliver_signup_notification(<%= file_name %>)
+  end
+
+  def after_save(<%= file_name %>)
+  <% if options[:include_activation] %>
+    <%= class_name %>Mailer.deliver_activation(<%= file_name %>) if <%= file_name %>.recently_activated?
+  <% end %>
+  end
+end

data/lib/generators/somatics/authenticated/templates/test/mailer_test.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '/../test_helper'
+require '<%= file_name %>_mailer'
+
+class <%= class_name %>MailerTest < Test::Unit::TestCase
+  FIXTURES_PATH = File.dirname(__FILE__) + '/../fixtures'
+  CHARSET = "utf-8"
+
+  include ActionMailer::Quoting
+
+  def setup
+    ActionMailer::Base.delivery_method = :test
+    ActionMailer::Base.perform_deliveries = true
+    ActionMailer::Base.deliveries = []
+
+    @expected = TMail::Mail.new
+    @expected.set_content_type "text", "plain", { "charset" => CHARSET }
+  end
+
+  def test_dummy_test
+    #do nothing
+  end
+
+  private
+    def read_fixture(action)
+      IO.readlines("#{FIXTURES_PATH}/<%= file_name %>_mailer/#{action}")
+    end
+
+    def encode(subject)
+      quoted_printable(subject, CHARSET)
+    end
+end

data/lib/generators/somatics/authenticated/templates/test/model_functional_test.rb

@@ -0,0 +1,93 @@
+require File.dirname(__FILE__) + '/../test_helper'
+require '<%= model_controller_file_name %>_controller'
+
+# Re-raise errors caught by the controller.
+class <%= model_controller_class_name %>Controller; def rescue_action(e) raise e end; end
+
+class <%= model_controller_class_name %>ControllerTest < ActionController::TestCase
+  # Be sure to include AuthenticatedTestHelper in test/test_helper.rb instead
+  # Then, you can remove it from this and the units test.
+  include <%= class_name %>AuthenticatedTestHelper
+
+  fixtures :<%= table_name %>
+
+  def test_should_allow_signup
+    assert_difference '<%= class_name %>.count' do
+      create_<%= file_name %>
+      assert_response :redirect
+    end
+  end
+
+  def test_should_require_login_on_signup
+    assert_no_difference '<%= class_name %>.count' do
+      create_<%= file_name %>(:login => nil)
+      assert assigns(:<%= file_name %>).errors.on(:login)
+      assert_response :success
+    end
+  end
+
+  def test_should_require_password_on_signup
+    assert_no_difference '<%= class_name %>.count' do
+      create_<%= file_name %>(:password => nil)
+      assert assigns(:<%= file_name %>).errors.on(:password)
+      assert_response :success
+    end
+  end
+
+  def test_should_require_password_confirmation_on_signup
+    assert_no_difference '<%= class_name %>.count' do
+      create_<%= file_name %>(:password_confirmation => nil)
+      assert assigns(:<%= file_name %>).errors.on(:password_confirmation)
+      assert_response :success
+    end
+  end
+
+  def test_should_require_email_on_signup
+    assert_no_difference '<%= class_name %>.count' do
+      create_<%= file_name %>(:email => nil)
+      assert assigns(:<%= file_name %>).errors.on(:email)
+      assert_response :success
+    end
+  end
+  <% if options[:stateful] %>
+  def test_should_sign_up_user_in_pending_state
+    create_<%= file_name %>
+    assigns(:<%= file_name %>).reload
+    assert assigns(:<%= file_name %>).pending?
+  end<% end %>
+
+  <% if options[:include_activation] %>
+  def test_should_sign_up_user_with_activation_code
+    create_<%= file_name %>
+    assigns(:<%= file_name %>).reload
+    assert_not_nil assigns(:<%= file_name %>).activation_code
+  end
+
+  def test_should_activate_user
+    assert_nil <%= class_name %>.authenticate('aaron', 'test')
+    get :activate, :activation_code => <%= table_name %>(:aaron).activation_code
+    assert_redirected_to '/<%= controller_routing_path %>/new'
+    assert_not_nil flash[:notice]
+    assert_equal <%= table_name %>(:aaron), <%= class_name %>.authenticate('aaron', 'monkey')
+  end
+  
+  def test_should_not_activate_user_without_key
+    get :activate
+    assert_nil flash[:notice]
+  rescue ActionController::RoutingError
+    # in the event your routes deny this, we'll just bow out gracefully.
+  end
+
+  def test_should_not_activate_user_with_blank_key
+    get :activate, :activation_code => ''
+    assert_nil flash[:notice]
+  rescue ActionController::RoutingError
+    # well played, sir
+  end<% end %>
+
+  protected
+    def create_<%= file_name %>(options = {})
+      post :create, :<%= file_name %> => { :login => 'quire', :email => 'quire@example.com',
+        :password => 'quire69', :password_confirmation => 'quire69' }.merge(options)
+    end
+end