tomafro-penknife 0.1.1

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'rake'
+
+folders = %w{rails lib recipes tasks spec features}.collect {|f| "#{f}/**/*"}
+
+GEM_FILES = FileList[
+  *['[a-zA-Z]*', folders] 
+]
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "penknife"
+    gem.summary = %{All purpose toolkit for rails}
+    gem.email = "tom@popdog.net"
+    gem.homepage = "http://github.com/tomafro/penknife"
+    gem.authors = ["Tom Ward"]
+    gem.files = GEM_FILES.to_a
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 1
+:patch: 1

data/lib/penknife.rb

@@ -0,0 +1,2 @@
+module Penknife
+end

data/lib/penknife/active_record.rb

@@ -0,0 +1,5 @@
+module Penknife::ActiveRecord
+  def invalid?
+    !valid?
+  end
+end

data/lib/penknife/active_record/column_reader.rb

@@ -0,0 +1,28 @@
+module Penknife::ActiveRecord::ColumnReader
+  def column_reader(column_name, options = {})
+    name = options.delete(:as) || column_name.to_s.pluralize
+    behaviour_module = column_reader_module(column_name)
+    column = columns_hash[column_name.to_s]
+    
+    behaviour_module.module_eval %{
+      def #{name}(options = {})
+        connection.select_all(construct_finder_sql(options.merge(:select => '#{column_name}'))).collect do |value| 
+          v = value.values.first
+          #{column.type_cast_code('v')}
+        end
+      end
+    }
+    extend behaviour_module
+  end
+  
+  private
+  
+  def column_reader_module(column_name)
+    module_name = "Raw#{column_name.to_s.camelize}Access"
+    if constants.include?(module_name)
+      const_get(module_name)
+    else
+      const_set(module_name, Module.new)    
+    end
+  end
+end

data/lib/penknife/active_record/permalink.rb

@@ -0,0 +1,22 @@
+module Penknife::ActiveRecord::Permalink
+  def has_permalink(attribute)
+    has_slug attribute
+    include Behaviour
+  end
+  
+  module Behaviour
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+    
+    def to_param
+      self.permalink
+    end
+    
+    module ClassMethods
+      def from_param(param)
+        self.find_by_permalink(param)
+      end
+    end
+  end
+end

data/lib/penknife/enhanced_form_builder.rb

@@ -0,0 +1,84 @@
+class Penknife::EnhancedFormBuilder < ActionView::Helpers::FormBuilder
+  include ActionView::Helpers::TagHelper, ActionView::Helpers::FormTagHelper
+  
+  (field_helpers - %w(hidden_field label check_box radio_button fields_for)).each do |selector|
+    src = <<-end_src
+      def #{selector}(method, options = {})
+        within_form_row(method, #{selector.inspect}, options) do
+          @template.send(#{selector.inspect}, @object_name, method, objectify_options(options))
+        end
+      end
+    end_src
+    class_eval src, __FILE__, __LINE__
+  end
+  
+  def check_box(method, options = {}, checked_value = "1", unchecked_value = "0")
+    within_form_row(method, 'check_box', options) do
+      @template.check_box(@object_name, method, objectify_options(options), checked_value, unchecked_value)
+    end
+  end
+  
+  def select(method, choices, options = {}, html_options = {})
+    within_form_row(method, 'check_box', options) do
+      @template.select(@object_name, method, choices, objectify_options(options), @default_options.merge(html_options))
+    end
+  end
+
+  def radio_button(method, tag_value, options = {})
+    @template.radio_button(@object_name, method, tag_value, objectify_options(options))
+  end
+
+  def submit(value = "Save changes", options = {})
+    within_form_row('&nbsp', nil, options.merge(:title => '')) do
+      submit_button(value, options.reverse_merge(:id => "#{object_name}_submit"))
+    end
+  end
+  
+  def submit_button(value = "Save changes", options = {})
+    options.stringify_keys!
+
+    if disable_with = options.delete("disable_with")
+      disable_with = "this.value='#{disable_with}'"
+      disable_with << ";#{options.delete('onclick')}" if options['onclick']
+      
+      options["onclick"] = [
+        "this.setAttribute('originalValue', this.value)",
+        "this.disabled=true",
+        disable_with,
+        "result = (this.form.onsubmit ? (this.form.onsubmit() ? this.form.submit() : false) : this.form.submit())",
+        "if (result == false) { this.value = this.getAttribute('originalValue'); this.disabled = false }",
+        "return result;",
+      ].join(";")
+    end
+
+    if confirm = options.delete("confirm")
+      options["onclick"] ||= ''
+      options["onclick"] += "return #{confirm_javascript_function(confirm)};"
+    end
+
+    tag(:button, { "type" => "submit", "name" => "commit" }.update(options.stringify_keys), true) + value + "</button>"
+  end
+  
+  private 
+  
+  def within_form_row(method, style, options = {}, &block)
+    description = options.delete(:description)
+    options[:class] = style
+    name = options[:title] || method.to_s.humanize
+    if options.delete(:required)
+      name << '*'
+    end
+            
+    result = label(method, name) + yield
+    
+    row_class = 'form-row'
+    if object && object.errors.on(options[:errors_from] || method)
+      row_class << ' errors'
+      result << " " << content_tag('div', object.errors.on(options[:errors_from] || method), :class => 'error')
+    elsif description
+      result << " " << content_tag('div', description, :class => 'description')
+    end
+    
+    content_tag('div', result, :class => row_class)
+  end
+end

data/lib/penknife/rake.rb

@@ -0,0 +1,41 @@
+require 'penknife'
+
+begin
+  rspec_base = File.expand_path("#{RAILS_ROOT}/vendor/plugins/rspec/lib")
+  $LOAD_PATH.unshift(rspec_base) if File.exist?(rspec_base) && !$LOAD_PATH.include?(rspec_base)
+  require 'spec/rake/spectask'
+rescue Object => e
+end
+
+module Penknife::Rake
+  def self.define_plugin_tasks_for(plugin)
+    plugin = plugin.to_s
+    plugin_path = "#{RAILS_ROOT}/vendor/plugins/#{plugin}"
+    
+    namespace plugin do
+      if Object.const_defined?(:Spec)
+        desc "Run #{plugin} specs"
+        Spec::Rake::SpecTask.new(:spec => "db:test:prepare") do |t|
+          t.spec_opts = ["-f n -c"]
+          t.spec_files = FileList["#{plugin_path}/spec/**/*_spec.rb"]
+        end
+      else
+        task :spec do
+          puts "To run specs for #{plugin} you must install rspec"
+        end
+      end
+      
+      desc "#{plugin.titleize} stats"
+      task :stats do
+        require 'code_statistics'
+        ::CodeStatistics::TEST_TYPES << "#{plugin.titleize} specs"
+        directories = [
+          [plugin.titleize + " code", "lib"],
+          [plugin.titleize + " specs", "spec"]
+        ].collect { |name, dir| 
+          [name, File.expand_path(File.join(plugin_path, dir))]}.select { |name, dir| File.directory?(dir) }
+        CodeStatistics.new(*directories).to_s
+      end
+    end
+  end
+end

data/lib/penknife/rspec.rb

@@ -0,0 +1,47 @@
+require 'penknife'
+require 'spec'
+require 'spec/rails'
+
+module Penknife::Rspec
+  module ExampleGroupExtensions
+    def doing(&block)
+      lambda(&block)
+    end
+    
+    Spec::Example::ExampleMethods.module_eval do
+      include Penknife::Rspec::ExampleGroupExtensions
+    end
+  end
+end
+
+
+
+# 
+# module Spec
+#   module Mocks
+#     module SpecMethods
+#       def redefine_models
+#         redefine_classes(:SpraypaintPub, :SpraypaintCinema, :superclass => ActiveRecord::Base)
+#       end
+#       
+#       def redefine_classes(*classes)
+#         options = classes.last.is_a?(Hash) ? classes.pop : {}
+#         classes.each do |class_name|
+#           Object.remove_class(class_name.to_s.constantize) if Object.const_defined?(class_name)
+#           Object.const_set(class_name, Class.new(options[:superclass] || Object))
+#         end
+#       end
+#       
+#       def tags
+#         @tags ||= Hash.new do |hash, key| 
+#           tag = Tomafro::Spraypaint::SpraypaintTag.find_or_create_by_name(key)
+#           hash[key] = tag
+#         end
+#       end
+#       
+#       def doing(&block)
+#         lambda(&block)
+#       end
+#     end
+#   end
+# end

data/lib/penknife/spec.rb

@@ -0,0 +1,13 @@
+module Penknife
+  module Spec
+  end
+end
+
+require 'penknife/spec/doing'
+require 'penknife/spec/pending_block'
+require 'penknife/spec/time_travel'
+
+Spec::Example::ExampleMethods.module_eval do
+  include Penknife::Spec::Doing
+end
+

data/lib/penknife/spec/controller_example_group_extensions.rb

@@ -0,0 +1,120 @@
+module Penknife
+  module Spec
+    module ControllerExampleGroupExtensions
+      include ::ActionController::StatusCodes
+      
+      def self.extended(base)
+        base.class_eval do
+          include InstanceMethods
+        end
+      end
+      
+      def describe(*args, &example_group_block)
+        if example_group_block
+          super
+        else
+          extract_action_from_args!(args)
+          extract_parameters_from_args(*args)
+          returning(clazz = super(*args, &example_group_block)) do
+            clazz.class_eval %{
+              before(:each) do
+                @it = @controller
+                params.merge!(self.class.described_action_parameters.dup)
+                request.env["HTTP_REFERER"] = "http://test.host/originalurl"
+                request.env['HTTP_USER_AGENT'] = "test"
+              end
+
+              def do_request
+                send self.class.described_action_method, self.class.described_action, params
+              end
+            }
+          end
+        end
+      end
+      
+      def described_action
+        @described_action || (superclass.respond_to?(:described_action) ? superclass.described_action : nil)
+      end
+      
+      def described_action_method
+        @described_action_method || (superclass.respond_to?(:described_action_method) ? superclass.described_action_method : nil)
+      end
+      
+      def described_action_parameters
+        (superclass.respond_to?(:described_action_parameters) ? superclass.described_action_parameters : {}).merge(@described_action_parameters || {})
+      end
+      
+      def extract_action_from_args!(args)
+        options = args.extract_options!
+        args.collect! do |argument| 
+          if @described_action.nil? && argument.is_a?(Symbol)
+            @described_action = args.first
+            @described_action_method = options[:method] || default_action_method_for(@described_action)
+            "doing #{@described_action_method.to_s.upcase} #{described_action}"
+          else
+            argument
+          end
+        end
+        args << options
+      end
+      
+      def extract_parameters_from_args(*args)
+        options = args.dup.extract_options!
+        if (options[:with_params] || options[:params]) 
+          @described_action_parameters = (options[:with_params] || options[:params]) 
+        end
+      end
+      
+      def description_parts 
+        returning(super) do |parts|
+          parts << " with #{described_action_parameters.inspect}" unless described_action_parameters.empty?
+        end
+      end
+      
+      def default_action_method_for(action)
+        case action.to_sym
+          when :create then :post
+          when :update then :put
+          when :destroy then :delete
+          else :get
+        end
+      end
+      
+      def it_should_respond_with(status)
+        raise "Status #{status} not known" unless status = SYMBOL_TO_STATUS_CODE[status]
+        it "should respond with status #{status} (#{STATUS_CODES[status]})" do
+          do_request
+          response.code.to_s.should == status.to_s
+        end
+      end
+      
+      def it_should_redirect_to(*args)
+        path_hash = args.extract_options!
+        message ||= path_hash.inspect
+        it "should redirect to #{message}" do
+          do_request
+          @response.should redirect_to(path_hash)
+        end
+      end
+      
+      module InstanceMethods
+        # Yields to block, then calls request.  e.g:
+        #   during_request {@it.should_receive(:some_method)}
+        
+        def during_request(&block)
+          yield
+          do_request
+        end
+        
+        
+        # Calls request, then yields to block.  e.g:
+        #   after_request {assigns[:organisations].should == @organisations}
+        
+        def after_request(&block)
+          do_request
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/penknife/spec/doing.rb

@@ -0,0 +1,11 @@
+require 'penknife/spec'
+
+module Penknife
+  module Spec
+    module Doing
+      def doing(&block)
+        lambda(&block)
+      end
+    end
+  end
+end

data/lib/penknife/spec/time_travel.rb

@@ -0,0 +1,20 @@
+class << Time
+  unless method_defined? :now_before_time_travel
+    alias_method :now_before_time_travel, :now
+  end
+  
+  def now 
+    @now || now_before_time_travel 
+  end
+  
+  def freeze(&block)
+    travel_to(Time.now, &block)
+  end 
+  
+  def travel_to(time = Time.now, &block)
+    @now = time
+    block.call
+  ensure
+    @now = nil
+  end
+end

data/penknife.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+  s.name = %q{penknife}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tom Ward"]
+  s.date = %q{2009-03-24}
+  s.email = %q{tom@popdog.net}
+  s.extra_rdoc_files = ["README"]
+  s.files = ["lib", "penknife.gemspec", "pkg", "rails", "Rakefile", "README", "recipes", "spec", "tasks", "VERSION.yml", "rails/init.rb", "lib/penknife", "lib/penknife/active_record", "lib/penknife/active_record/column_reader.rb", "lib/penknife/active_record/permalink.rb", "lib/penknife/active_record.rb", "lib/penknife/enhanced_form_builder.rb", "lib/penknife/rake.rb", "lib/penknife/rspec.rb", "lib/penknife/spec", "lib/penknife/spec/controller_example_group_extensions.rb", "lib/penknife/spec/doing.rb", "lib/penknife/spec/pending_block.rb", "lib/penknife/spec/time_travel.rb", "lib/penknife/spec.rb", "lib/penknife.rb", "recipes/backup.rb", "tasks/backup.rake", "tasks/penknife.rake", "spec/extensions", "spec/extensions/active_record_spec.rb", "spec/spec_helper.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/tomafro/penknife}
+  s.rdoc_options = ["--inline-source", "--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.2.0}
+  s.summary = %q{All purpose toolkit for rails}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if current_version >= 3 then
+    else
+    end
+  else
+  end
+end

data/rails/init.rb

@@ -0,0 +1,5 @@
+ActiveRecord::Base.module_eval do
+  include Penknife::ActiveRecord
+  extend Penknife::ActiveRecord::Permalink
+  extend Penknife::ActiveRecord::ColumnReader
+end

data/recipes/backup.rb

@@ -0,0 +1,46 @@
+# Perform backups
+#
+# To automatically transfer backups to your local machine, add:
+#   after "backup:create", "backup:download"
+#
+ 
+_cset(:backup_path) { "#{shared_path}/backups" }
+ 
+namespace :backup do
+  def latest
+    capture("cd #{current_path}; rake -s db:backup:latest BACKUP_DIR=#{backup_path}").split("\n").last.strip
+  end
+ 
+  task :link_folder, :roles => :db, :only => {:primary => true} do
+    run "mkdir -p #{backup_path}"
+    run "ln -s #{backup_path} #{latest_release}/backups"
+  end
+ 
+  desc "Create a backup on the server"
+  task :create, :roles => :db, :only => {:primary => true} do
+    rails_env = fetch(:rails_env, "production")
+    run "cd #{current_path}; rake db:backup:create RAILS_ENV=#{rails_env} BACKUP_DIR=#{backup_path}"
+  end
+  
+  desc "Retreive a backup from the server. Gets the latest by default, set :backup_version to specify which version to copy"
+  task :download, :roles => :db, :only => {:primary => true} do
+    version = fetch(:backup_version, latest)
+    run "tar -C #{backup_path} -czf #{backup_path}/#{version}.tar.gz #{version}"
+    `mkdir -p backups`
+    get "#{backup_path}/#{version}.tar.gz", "backups/#{version}.tar.gz"
+    run "rm #{backup_path}/#{version}.tar.gz"
+    `tar -C backups -zxf backups/#{version}.tar.gz`
+    `rm backups/#{version}.tar.gz`
+  end
+  
+  desc "Creates a new remote backup and clones it to the local database"
+  task :mirror, :roles => :db, :only => {:primary => true} do
+    create
+    download
+    `rake db:backup:restore`
+  end
+  
+  task :mirror_production, :roles => :db do
+    run "cd #{current_path}; cap production backup:mirror"
+  end
+end

data/spec/extensions/active_record_spec.rb

@@ -0,0 +1,8 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe ActiveRecord::Base do
+  describe "#invalid?" do
+    it "should return false if valid? returns true"
+    it "should return true if valid? returns false"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path(__FILE__ + "/../../../../../config/environment")
+require 'penknife/rspec'
+
+Spec::Rails::Example::ControllerExampleGroup.module_eval do
+  extend Penknife::Spec::ControllerExampleGroupExtensions
+end
+
+Spec::Example::ExampleGroupFactory.register(:"penknife/controllers", Spec::Rails::Example::ControllerExampleGroup)
+

data/tasks/backup.rake

@@ -0,0 +1,46 @@
+namespace :db do
+  namespace :backup do  
+    def backup_directory
+      ENV['BACKUP_DIR'] ||= File.join(RAILS_ROOT, 'backups')
+    end
+    
+    def latest_backup
+      last = Dir["#{backup_directory}/*"].sort.last
+      File.basename(last) if last
+    end   
+    
+    task :latest => :environment do
+      if latest_backup
+        puts ENV['BACKUP'] = latest_backup
+      else
+        puts "No backups found in #{backup_directory}"
+      end
+    end
+      
+    # Setup environment variables for the schema and fixtures tasks
+    task :setup => :environment do
+      ENV['BACKUP'] ||= Time.now.utc.strftime('%Y%m%d%H%M%S.sql')
+      FileUtils.mkdir_p backup_directory
+    end
+      
+    desc 'Create a new backup of the database'
+    task :create => :setup do
+      config = ActiveRecord::Base.configurations[RAILS_ENV]
+      backup_file = File.expand_path(File.join(ENV['BACKUP_DIR'], ENV['BACKUP']))
+      case config["adapter"]
+        when "mysql" then puts `mysqldump -u #{config["username"]} #{config["database"]} > #{backup_file}`
+        else raise "Adapter #{config["adapter"]} not currently supported"
+      end
+    end
+    
+    task :restore => [:environment] do
+      ENV['BACKUP'] ||= latest_backup
+      config = ActiveRecord::Base.configurations[RAILS_ENV]
+      backup_file = File.expand_path(File.join(ENV['BACKUP_DIR'], ENV['BACKUP']))
+      case config["adapter"]
+        when "mysql" then puts `mysql -u #{config["username"]} #{config["database"]} < #{backup_file}`
+        else raise "Adapter #{config["adapter"]} not currently supported"  
+      end
+    end
+  end
+end

data/tasks/penknife.rake

@@ -0,0 +1,6 @@
+penknife_base = File.join(RAILS_ROOT, 'vendor', 'plugins', 'penknife', 'lib')
+$LOAD_PATH.unshift(penknife_base) if File.exist?(penknife_base) && !$LOAD_PATH.include?(penknife_base)
+
+require 'penknife/rake'
+
+Penknife::Rake.define_plugin_tasks_for(:penknife)

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: tomafro-penknife
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Tom Ward
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-24 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: tom@popdog.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib
+- penknife.gemspec
+- pkg
+- rails
+- Rakefile
+- README
+- recipes
+- spec
+- tasks
+- VERSION.yml
+- rails/init.rb
+- lib/penknife
+- lib/penknife/active_record
+- lib/penknife/active_record/column_reader.rb
+- lib/penknife/active_record/permalink.rb
+- lib/penknife/active_record.rb
+- lib/penknife/enhanced_form_builder.rb
+- lib/penknife/rake.rb
+- lib/penknife/rspec.rb
+- lib/penknife/spec
+- lib/penknife/spec/controller_example_group_extensions.rb
+- lib/penknife/spec/doing.rb
+- lib/penknife/spec/pending_block.rb
+- lib/penknife/spec/time_travel.rb
+- lib/penknife/spec.rb
+- lib/penknife.rb
+- recipes/backup.rb
+- tasks/backup.rake
+- tasks/penknife.rake
+- spec/extensions
+- spec/extensions/active_record_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/tomafro/penknife
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: All purpose toolkit for rails
+test_files: []
+