sandro-homeward 0.1.0 → 0.1.1

data/History.txt

@@ -1,2 +1,13 @@
+== 0.1.1 / 2009-01-12
+* 2 major enhancements
+  - Providing a mechanism for creating application specific settings via config/settings.yml. Access your settings via the APP_CONFIG constant
+  - The homeward generator creates all homeward files, including the application_layout; the homeward_layout generator has been removed
+
+* 3 minor enhancements
+  - View and Controller helpers now mixed-in to ActionView::Base and ActionController::Base [thanks tpope]
+  - Added config/initializers/constants.rb to the generator
+  - Added config/settings.yml and config/settings.yml.example to the generator
+    - Note: you should add config/settings.yml to your .gitignore
+
 == 0.1.0 / 2009-01-04
 * Birthday!

data/Manifest.txt

@@ -1,19 +1,17 @@
 History.txt
 Manifest.txt
 README.markdown
-README.txt
 Rakefile
 generators/homeward/USAGE
 generators/homeward/homeward_generator.rb
+generators/homeward/templates/application.html.haml
+generators/homeward/templates/constants.rb
 generators/homeward/templates/homeward.rake
-generators/homeward_layout/USAGE
-generators/homeward_layout/homeward_layout_generator.rb
-generators/homeward_layout/templates/application.html.haml
+generators/homeward/templates/settings.yml
 init.rb
 lib/homeward.rb
-lib/homeward/controllers/application.rb
-lib/homeward/helpers/application_helper.rb
+lib/homeward/controller_helpers.rb
+lib/homeward/view_helpers.rb
 rails/init.rb
 spec/homeward_spec.rb
 spec/spec_helper.rb
-tasks/homeward.rake

data/README.markdown

@@ -1,6 +1,6 @@
 Homeward
 ==========
-by Sandro Turriate  
+by Sandro Turriate
 http://github.com/sandro/homeward
 
 DESCRIPTION:
@@ -10,52 +10,43 @@ Rakefile and generators to help create my baseapp
 FEATURES:
 --------
 Installs Blueprint css  
-Replaces Prototype with jQuery  
-Creates an application layout which includes Blueprint and jQuery  
-Includes a `render_flashes` application\_helper method which will render a flash message when available  
-Includes a `current_page` helper to be used with will\_paginate  
+Replaces prototype with jrails  
+Creates an application layout which includes Blueprint and jrails  
+Creates config/settings.yml for application specific settings  
+Creates config/initializers/constants.rb with an APP\_CONFIG constant which consists of the settings defined in config/settings.yml  
+Defines `render_flashes` which will render a flash message when available, utilized by the layout  
+Defines `current_page` helper to be used with will\_paginate  
 
     rake homeward
-        Run all significant tasks
-        Create application layout
-        Update Blueprint
-        Install Blueprint
-        Replace prototype with jrails
-    
-    rake homeward:application_layout
-        Invokes the homeward_layout generator
-    
+        Update and install Blueprint, replace prototype with jrails
+
     rake homeward:blueprint:install
         installs blueprint
-    
+
     rake homeward:blueprint:update
         pulls the latest blueprint code
-    
+
     rake homeward:javascript:install_jrails
         installs jrails
-    
+
     rake homeward:javascript:remove_prototype
         removes prototype
-    
+
     rake homeward:javascript:use_jrails
         replaces prototype with jrails
 
-TODO/FIXES:
---------
-Don't re-open classes to define methods, they need to be overwritable.
-
-SYNOPSIS:
---------
-    script/generate homeward
-    rake homeward
-
 REQUIREMENTS:
 --------
 * Rails
+* Haml
+* blueprint-css cloned somewhere on your filesystem (see lib/tasks/homeward.rake)
 
 INSTALL:
 --------
-    sudo gem install --source http://gems.github.com sandro-homeward
+1. `config.gem 'sandro-homeward', :lib => 'homeward', :source => 'http://gems.github.com'`
+2. Edit the `BLUEPRINT_GIT_PATH` constant in lib/tasks/homeward.rake
+3. `script/generate homeward`
+4. `rake homeward`
 
 LICENSE:
 --------

data/Rakefile

@@ -20,7 +20,7 @@ task :default => 'spec:run'
 
 namespace :gem do
   task :redo do
-    puts %x(rm -rf pkg/homeward-1.0.0 && rake manifest:create && rake gem:reinstall)
+    puts %x(rm -rf pkg/homeward-1.0.0 && rake manifest:create && rake gem:reinstall && rake gem:spec)
   end
 end
 
@@ -32,9 +32,9 @@ PROJ.email = 'sandro.turriate@gmail.com'
 PROJ.url = 'http://github.com/sandro/homeward'
 PROJ.version = Homeward::VERSION
 PROJ.rubyforge.name = 'homeward'
+PROJ.readme_file = 'README.markdown'
 
 PROJ.spec.opts << '--color'
 
 PROJ.exclude << %w(.*.gemspec \.gitignore)
 
-# EOF

data/generators/homeward/USAGE

@@ -1,2 +1,5 @@
 Description:
   Adds the homeward rake task to lib/tasks/homeward.rake
+  Copies the homeward application layout to app/views/layouts/application.html.haml
+  Creates application wide settings adding settings.yml to config/
+

data/generators/homeward/homeward_generator.rb

@@ -1,12 +1,26 @@
 class HomewardGenerator < Rails::Generator::Base
+  attr_accessor :project_name
+
   def initialize(runtime_args, runtime_options = {})
-    Dir.mkdir('lib/tasks') unless File.directory?('lib/tasks')
     super
+    @project_name = File.basename(Rails.root).humanize
   end
 
   def manifest
     record do |m|
-      m.file 'homeward.rake', 'lib/tasks/homeward.rake', :collision => :ask
+      m.directory 'lib/tasks'
+      m.directory 'config/initializers'
+      m.directory 'app/views/layouts'
+
+      m.with_options :collision => :ask do |mc|
+        mc.file 'homeward.rake', 'lib/tasks/homeward.rake'
+
+        mc.template 'application.html.haml', 'app/views/layouts/application.html.haml'
+        mc.template 'constants.rb', 'config/initializers/constants.rb'
+        mc.template 'settings.yml', 'config/settings.yml'
+        mc.template 'settings.yml', 'config/settings.yml.example'
+      end
     end
   end
 end
+

data/generators/homeward/templates/constants.rb

@@ -0,0 +1,6 @@
+DO_NOT_REPLY = "donotreply@example.com"
+PROJECT_NAME = "<%= project_name %>"
+HOST = "localhost"
+
+APP_CONFIG = Homeward.load_app_config
+

data/generators/homeward/templates/homeward.rake

@@ -1 +1,51 @@
-/Users/santuri/Code/Ruby/homeward/tasks/homeward.rake
+require 'fileutils'
+
+BLUEPRINT_GIT_PATH = "#{ENV['HOME']}/Code/Css/blueprint-css"
+
+desc %q(Update and install Blueprint, replace prototype with jrails)
+task :homeward => %w(homeward:blueprint:update homeward:blueprint:install homeward:javascript:use_jrails)
+
+namespace :homeward do
+  namespace :blueprint do
+    desc 'pulls the latest blueprint code'
+    task :update do
+      Dir.chdir BLUEPRINT_GIT_PATH do
+        puts %x(echo "Stashing\n" &&
+                git stash &&
+                echo "\nPulling\n" &&
+                git pull &&
+                echo "\nPopping\n" &&
+                git stash pop
+               )
+      end
+    end
+
+    desc "installs blueprint"
+    task :install do
+      compressor = "#{BLUEPRINT_GIT_PATH}/lib/compress.rb"
+      install_path = "#{Rails.root}/public/stylesheets/blueprint"
+      %x(ruby #{compressor} -o #{install_path})
+      FileUtils.rm_rf "#{install_path}/src"
+    end
+  end
+
+  namespace :javascript do
+    desc 'replaces prototype with jrails'
+    task :use_jrails => [:remove_prototype, :install_jrails]
+
+    desc 'removes prototype'
+    task :remove_prototype do
+      Dir.chdir("#{Rails.root}/public/javascripts") do
+        FileUtils.rm_rf %w(prototype.js effects.js dragdrop.js controls.js)
+      end
+    end
+
+    desc 'installs jrails'
+    task :install_jrails do
+      Dir.chdir(Rails.root) do
+        puts %x(script/plugin install http://ennerchi.googlecode.com/svn/trunk/plugins/jrails)
+      end
+    end
+  end
+end
+

data/generators/homeward/templates/settings.yml

@@ -0,0 +1,14 @@
+base_settings: &base_settings
+  :todo: development
+
+development:
+  <<: *base_settings
+
+test:
+  <<: *base_settings
+  :todo: test
+
+production:
+  <<: *base_settings
+  :todo: production
+

data/lib/homeward/controller_helpers.rb

@@ -0,0 +1,10 @@
+module Homeward
+  module ControllerHelpers
+    protected
+
+    def current_page
+      params[:page].to_i < 1 ? 1 : params[:page].to_i
+    end
+  end
+end
+

data/lib/homeward/view_helpers.rb

@@ -0,0 +1,20 @@
+module Homeward
+  module ViewHelpers
+    def blueprint_includes
+      %q(
+      <link rel="stylesheet" href="/stylesheets/blueprint/screen.css" type="text/css" media="screen, projection">
+      <link rel="stylesheet" href="/stylesheets/blueprint/print.css" type="text/css" media="print">
+      <!--[if IE]>
+        <link rel="stylesheet" href="/stylesheets/blueprint/ie.css" type="text/css" media="screen, projection">
+      <![endif]-->
+      )
+    end
+
+    def render_flashes
+      flash.map do |type, value|
+        content_tag('div', value, :id => "flash_#{type}")
+      end.join("\n")
+    end
+  end
+end
+

data/lib/homeward.rb

@@ -1,5 +1,7 @@
+require 'yaml'
+
 module Homeward
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
 
@@ -22,7 +24,30 @@ module Homeward
 
     Dir.glob(search_me).sort.each {|rb| require rb}
   end
+
+  def self.define_method_unless_defined(klass, method_name, &block)
+    unless klass.method_defined?(method_name)
+      klass.send(:define_method, method_name, block)
+    end
+  end
+
+  def self.load_app_config
+    returning HashWithIndifferentAccess.new do |app_config|
+      config_file_path = File.join(RAILS_ROOT, %w(config settings.yml))
+      if File.exist?(config_file_path)
+        config = YAML.load_file(config_file_path)
+        app_config.merge!(config[Rails.env]) if config.has_key?(Rails.env)
+      else
+        puts "WARNING: configuration file #{config_file_path} not found."
+      end
+    end
+  end
 end
 
 Homeward.require_all_libs_relative_to(__FILE__)
 
+if Object.const_defined?(:Rails)
+  ActionView::Base.send(:include, Homeward::ViewHelpers)
+  ActionController::Base.send(:include, Homeward::ControllerHelpers)
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sandro-homeward
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Sandro Turriate
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-04 00:00:00 -08:00
+date: 2009-01-12 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -29,33 +29,30 @@ extensions: []
 
 extra_rdoc_files: 
 - History.txt
-- README.txt
 files: 
 - History.txt
 - Manifest.txt
 - README.markdown
-- README.txt
 - Rakefile
 - generators/homeward/USAGE
 - generators/homeward/homeward_generator.rb
+- generators/homeward/templates/application.html.haml
+- generators/homeward/templates/constants.rb
 - generators/homeward/templates/homeward.rake
-- generators/homeward_layout/USAGE
-- generators/homeward_layout/homeward_layout_generator.rb
-- generators/homeward_layout/templates/application.html.haml
+- generators/homeward/templates/settings.yml
 - init.rb
 - lib/homeward.rb
-- lib/homeward/controllers/application.rb
-- lib/homeward/helpers/application_helper.rb
+- lib/homeward/controller_helpers.rb
+- lib/homeward/view_helpers.rb
 - rails/init.rb
 - spec/homeward_spec.rb
 - spec/spec_helper.rb
-- tasks/homeward.rake
 has_rdoc: true
 homepage: http://github.com/sandro/homeward
 post_install_message: 
 rdoc_options: 
 - --main
-- README.txt
+- README.markdown
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/generators/homeward_layout/USAGE

@@ -1,2 +0,0 @@
-Description:
-  Copies the homeward layout to app/views/layouts/application.html.haml

data/generators/homeward_layout/homeward_layout_generator.rb

@@ -1,16 +0,0 @@
-class HomewardLayoutGenerator < Rails::Generator::Base
-  attr_accessor :project_name
-
-  def initialize(runtime_args, runtime_options = {})
-    super
-    @project_name = File.basename(Rails.root).humanize
-  end
-
-  def manifest
-    record do |m|
-      m.template 'application.html.haml', 'app/views/layouts/application.html.haml', :collision => :ask
-    end
-  end
-
-
-end

data/lib/homeward/controllers/application.rb

@@ -1,7 +0,0 @@
-class ApplicationController
-  private
-
-  def current_page
-    params[:page].to_i < 1 ? 1 : params[:page].to_i
-  end
-end

data/lib/homeward/helpers/application_helper.rb

@@ -1,17 +0,0 @@
-module ApplicationHelper
-  def blueprint_includes
-    %q(
-    <link rel="stylesheet" href="/stylesheets/blueprint/screen.css" type="text/css" media="screen, projection">
-    <link rel="stylesheet" href="/stylesheets/blueprint/print.css" type="text/css" media="print"> 
-    <!--[if IE]>
-      <link rel="stylesheet" href="/stylesheets/blueprint/ie.css" type="text/css" media="screen, projection">
-    <![endif]-->
-    )
-  end
-
-  def render_flashes
-    flash.map do |type, value|
-      content_tag('div', value, :id => "flash_#{type}")
-    end.join("\n")
-  end
-end

data/tasks/homeward.rake

@@ -1,63 +0,0 @@
-require 'fileutils'
-
-BLUEPRINT_GIT_PATH = "#{ENV['HOME']}/Code/Css/blueprint-css"
-
-desc %q(Run all significant tasks
-Create application layout
-Update Blueprint
-Install Blueprint
-Replace prototype with jrails
-)
-task :homeward => %w(homeward:application_layout homeward:blueprint:update homeward:blueprint:install homeward:javascript:use_jrails)
-
-namespace :homeward do
-  desc 'Invokes the homeward_layout generator'
-  task :application_layout do
-    Dir.chdir(Rails.root) do
-      puts %x(script/generate homeward_layout)
-    end
-  end
-
-  namespace :blueprint do
-    desc 'pulls the latest blueprint code'
-    task :update do
-      Dir.chdir BLUEPRINT_GIT_PATH do
-        puts %x(echo "Stashing\n" &&
-                git stash &&
-                echo "\nPulling\n" &&
-                git pull &&
-                echo "\nPopping\n" &&
-                git stash pop
-               )
-      end
-    end
-
-    desc "installs blueprint"
-    task :install do
-      compressor = "#{BLUEPRINT_GIT_PATH}/lib/compress.rb"
-      install_path = "#{Rails.root}/public/stylesheets/blueprint"
-      %x(ruby #{compressor} -o #{install_path})
-      FileUtils.rm_rf "#{install_path}/src"
-    end
-  end
-
-  namespace :javascript do
-    desc 'replaces prototype with jrails'
-    task :use_jrails => [:remove_prototype, :install_jrails]
-
-    desc 'removes prototype'
-    task :remove_prototype do
-      Dir.chdir("#{Rails.root}/public/javascripts") do
-        FileUtils.rm_rf %w(prototype.js effects.js dragdrop.js controls.js)
-      end
-    end
-
-    desc 'installs jrails'
-    task :install_jrails do
-      Dir.chdir(Rails.root) do
-        puts %x(script/plugin install http://ennerchi.googlecode.com/svn/trunk/plugins/jrails)
-      end
-    end
-  end
-end
-