boochtek-rails-crud_actions 0.0.2

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2009-01-25
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,15 @@
+features/development.feature
+features/steps/common.rb
+features/steps/env.rb
+History.txt
+lib/rails-crud_actions.rb
+Manifest.txt
+PostInstall.txt
+rails-crud_actions.gemspec
+Rakefile
+README.rdoc
+spec/rails-crud_actions_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake
+tmp/tests.out

data/PostInstall.txt

@@ -0,0 +1,3 @@
+
+For more information on rails-crud_actions, see http://github.com/boochtek/rails-crud_actions
+

data/README.rdoc

@@ -0,0 +1,62 @@
+= rails-crud_actions
+
+* http://github.com/boochtek/rails-crud_actions
+
+== DESCRIPTION:
+
+Provides default CRUD actions for a Rails controller.
+
+== FEATURES/PROBLEMS:
+
+* Provides default CRUD actions for a Rails controller.
+* Simply include the module, for simpler debugging.
+* Allows overriding the actions.
+* Provides the 7 CRUD actions provided by Rails scaffolding, plus 'delete'.
+  * Delete displays a page confirming that the user wants to delete an item.
+
+== SYNOPSIS:
+
+  class UsersController < ApplicationController
+    include BoochTek::Rails::CrudActions
+    crud_model = Person       # OPTIONAL: would have defaulted to User for the UsersController.
+    def index
+      # Can provide an overrided version of an action.
+    end
+    after_filter :only => :show do
+      # Can extend the functionality of the default version of an action. Can also use before_filter or around_filter.
+    end
+  end
+
+== REQUIREMENTS:
+
+* Rails (actually, ActionController)
+  * Will probably work with any version of Rails, but I've tested with Rails 2.2 and above.
+
+== INSTALL:
+
+* sudo gem install boochtek-rails-crud_actions -s http://gems.github.com
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 BoochTek, LLC
+
+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/Rakefile

@@ -0,0 +1,28 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/rails-crud_actions'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('rails-crud_actions', BoochTek::Rails::CrudActions::VERSION) do |p|
+  p.developer('Craig Buchek', 'craig@boochtek.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name       = p.name
+  # p.extra_deps         = [
+  #   ['activesupport','>= 2.0.2'],
+  # ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/features/development.feature

@@ -0,0 +1,13 @@
+Feature: Development processes of newgem itself (rake tasks)
+
+  As a Newgem maintainer or contributor
+  I want rake tasks to maintain and release the gem
+  So that I can spend time on the tests and code, and not excessive time on maintenance processes
+    
+  Scenario: Generate RubyGem
+    Given this project is active project folder
+    And 'pkg' folder is deleted
+    When task 'rake gem' is invoked
+    Then folder 'pkg' is created
+    And file with name matching 'pkg/*.gem' is created else you should run "rake manifest" to fix this
+    And gem spec key 'rdoc_options' contains /--mainREADME.rdoc/

data/features/steps/common.rb

@@ -0,0 +1,194 @@
+def in_project_folder(&block)
+  project_folder = @active_project_folder || @tmp_root
+  FileUtils.chdir(project_folder, &block)
+end
+
+def in_home_folder(&block)
+  FileUtils.chdir(@home_path, &block)
+end
+
+Given %r{^a safe folder} do
+  FileUtils.rm_rf   @tmp_root = File.dirname(__FILE__) + "/../../tmp"
+  FileUtils.mkdir_p @tmp_root
+  FileUtils.mkdir_p @home_path = File.expand_path(File.join(@tmp_root, "home"))
+  @lib_path = File.expand_path(File.dirname(__FILE__) + '/../../lib')
+  Given "env variable $HOME set to '#{@home_path}'"
+end
+
+Given %r{^this project is active project folder} do
+  Given "a safe folder"
+  @active_project_folder = File.expand_path(File.dirname(__FILE__) + "/../..")
+end
+
+Given %r{^env variable \$([\w_]+) set to '(.*)'} do |env_var, value|
+  ENV[env_var] = value
+end
+
+def force_local_lib_override(project_name = @project_name)
+  rakefile = File.read(File.join(project_name, 'Rakefile'))
+  File.open(File.join(project_name, 'Rakefile'), "w+") do |f|
+    f << "$:.unshift('#{@lib_path}')\n"
+    f << rakefile
+  end
+end
+
+def setup_active_project_folder project_name
+  @active_project_folder = File.join(@tmp_root, project_name)
+  @project_name = project_name
+end
+
+Given %r{'(.*)' folder is deleted} do |folder|
+  in_project_folder do
+    FileUtils.rm_rf folder
+  end
+end
+
+When %r{^'(.*)' generator is invoked with arguments '(.*)'$} do |generator, arguments|
+  @stdout = StringIO.new
+  FileUtils.chdir(@active_project_folder) do
+    if Object.const_defined?("APP_ROOT")
+      APP_ROOT.replace(FileUtils.pwd)
+    else 
+      APP_ROOT = FileUtils.pwd
+    end
+    run_generator(generator, arguments.split(' '), SOURCES, :stdout => @stdout)
+  end
+  File.open(File.join(@tmp_root, "generator.out"), "w") do |f|
+    @stdout.rewind
+    f << @stdout.read
+  end
+end
+
+When %r{run executable '(.*)' with arguments '(.*)'} do |executable, arguments|
+  @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
+  in_project_folder do
+    system "#{executable} #{arguments} > #{@stdout} 2> #{@stdout}"
+  end
+end
+
+When %r{run project executable '(.*)' with arguments '(.*)'} do |executable, arguments|
+  @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
+  in_project_folder do
+    system "ruby #{executable} #{arguments} > #{@stdout} 2> #{@stdout}"
+  end
+end
+
+When %r{run local executable '(.*)' with arguments '(.*)'} do |executable, arguments|
+  @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
+  executable = File.expand_path(File.join(File.dirname(__FILE__), "/../../bin", executable))
+  in_project_folder do
+    system "ruby #{executable} #{arguments} > #{@stdout} 2> #{@stdout}"
+  end
+end
+
+When %r{^task 'rake (.*)' is invoked$} do |task|
+  @stdout = File.expand_path(File.join(@tmp_root, "tests.out"))
+  FileUtils.chdir(@active_project_folder) do
+    system "rake #{task} --trace > #{@stdout} 2> #{@stdout}"
+  end
+end
+
+Then %r{^folder '(.*)' (is|is not) created} do |folder, is|
+  in_project_folder do
+    File.exists?(folder).should(is == 'is' ? be_true : be_false)
+  end
+end
+
+Then %r{^file '(.*)' (is|is not) created} do |file, is|
+  in_project_folder do
+    File.exists?(file).should(is == 'is' ? be_true : be_false)
+  end
+end
+
+Then %r{^file with name matching '(.*)' is created} do |pattern|
+  in_project_folder do
+    Dir[pattern].should_not be_empty
+  end
+end
+
+Then %r{gem file '(.*)' and generated file '(.*)' should be the same} do |gem_file, project_file|
+  File.exists?(gem_file).should be_true
+  File.exists?(project_file).should be_true
+  gem_file_contents = File.read(File.dirname(__FILE__) + "/../../#{gem_file}")
+  project_file_contents = File.read(File.join(@active_project_folder, project_file))
+  project_file_contents.should == gem_file_contents
+end
+
+Then %r{^output same as contents of '(.*)'$} do |file|
+  expected_output = File.read(File.join(File.dirname(__FILE__) + "/../expected_outputs", file))
+  actual_output = File.read(@stdout)
+  actual_output.should == expected_output
+end
+
+Then %r{^(does|does not) invoke generator '(.*)'$} do |does_invoke, generator|
+  actual_output = File.read(@stdout)
+  does_invoke == "does" ?
+    actual_output.should(match(/dependency\s+#{generator}/)) :
+    actual_output.should_not(match(/dependency\s+#{generator}/))
+end
+
+Then %r{help options '(.*)' and '(.*)' are displayed} do |opt1, opt2|
+  actual_output = File.read(@stdout)
+  actual_output.should match(/#{opt1}/)
+  actual_output.should match(/#{opt2}/)
+end
+
+Then %r{^output (does|does not) match \/(.*)\/} do |does, regex|
+  actual_output = File.read(@stdout)
+  (does == 'does') ?
+    actual_output.should(match(/#{regex}/)) :
+    actual_output.should_not(match(/#{regex}/)) 
+end
+
+Then %r{^contents of file '(.*)' (does|does not) match \/(.*)\/} do |file, does, regex|
+  in_project_folder do
+    actual_output = File.read(file)
+    (does == 'does') ?
+      actual_output.should(match(/#{regex}/)) :
+      actual_output.should_not(match(/#{regex}/))
+  end
+end
+
+Then %r{^all (\d+) tests pass} do |expected_test_count|
+  expected = %r{^#{expected_test_count} tests, \d+ assertions, 0 failures, 0 errors}
+  actual_output = File.read(@stdout)
+  actual_output.should match(expected)
+end
+
+Then %r{^all (\d+) examples pass} do |expected_test_count|
+  expected = %r{^#{expected_test_count} examples?, 0 failures}
+  actual_output = File.read(@stdout)
+  actual_output.should match(expected)
+end
+
+Then %r{^yaml file '(.*)' contains (\{.*\})} do |file, yaml|
+  in_project_folder do
+    yaml = eval yaml
+    YAML.load(File.read(file)).should == yaml
+  end
+end
+
+Then %r{^Rakefile can display tasks successfully} do
+  @stdout = File.expand_path(File.join(@tmp_root, "rakefile.out"))
+  FileUtils.chdir(@active_project_folder) do
+    system "rake -T > #{@stdout} 2> #{@stdout}"
+  end
+  actual_output = File.read(@stdout)
+  actual_output.should match(/^rake\s+\w+\s+#\s.*/)
+end
+
+Then %r{^task 'rake (.*)' is executed successfully} do |task|
+  @stdout.should_not be_nil
+  actual_output = File.read(@stdout)
+  actual_output.should_not match(/^Don't know how to build task '#{task}'/)
+  actual_output.should_not match(/Error/i)
+end
+
+Then %r{^gem spec key '(.*)' contains \/(.*)\/} do |key, regex|
+  in_project_folder do
+    gem_file = Dir["pkg/*.gem"].first
+    gem_spec = Gem::Specification.from_yaml(`gem spec #{gem_file}`)
+    spec_value = gem_spec.send(key.to_sym)
+    spec_value.to_s.should match(/#{regex}/)
+  end
+end

data/features/steps/env.rb

@@ -0,0 +1,6 @@
+require File.dirname(__FILE__) + "/../../lib/rails-crud_actions"
+
+gem 'cucumber'
+require 'cucumber'
+gem 'rspec'
+require 'spec'

data/lib/rails-crud_actions.rb

@@ -0,0 +1,93 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module BoochTek
+  module Rails
+    module CrudActions
+      VERSION = '0.0.2'
+      class << self
+        def included(base)
+          base.extend ClassMethods
+        end
+      end
+
+      module ClassMethods
+        def crud_model=(model)
+          @@current_model = (model.class == Class) ? model : model.constantize
+        end
+      end
+        # This implementation based on http://blog.boldr.fr/posts/datamapper-0-9-avec-rails
+        #before_filter :new_item,  :only => [:new, :create]
+        #before_filter :find_item, :only => [:show, :edit, :update, :delete, :destroy]
+        #before_filter :find_items, :only => [:index]
+        #before_filter :fill_item, :only => [:create, :update]
+        # TODO: after_filters for finding default views.
+        # TODO: Filtering of items visible to a user.
+        # TODO: Complex filtering of index, for searching. (Similar to Justin's solution.)
+        # TODO: User-specifed model or collection.
+        # TODO: Pagination.
+        # TODO: Automatic rendering of a default page. (Separate module/gem.)
+      def index
+      end
+
+      def show
+      end
+
+      def new
+      end
+
+      def edit
+      end
+
+      def delete
+      end
+
+      def create
+        save_or_render 'new'
+      end
+
+      def update
+        save_or_render 'edit'
+      end
+
+      def destroy
+        @current_item.destroy
+        respond_to do |format|
+          format.html { redirect_to(self.send("#{current_model.table_name.singularize}_index_url")) }
+          format.xml  { head :ok }
+        end
+      end
+
+      protected
+
+      def new_item
+        @current_item = current_model.new
+      end
+
+      def find_item
+        @current_item = current_model[params[:id]]
+      end
+
+      def find_items
+        @current_items = current_model.all
+      end
+
+      def fill_item
+        @current_item.attributes = params[:item]
+      end
+
+      def save_or_render(action)
+        if @current_item.save
+          redirect_to @current_item
+        else
+          render :action => action
+        end
+      end
+
+      def current_model
+        @@current_model ||= controller_name.singularize.camelize.constantize
+      end
+
+    end
+  end
+end

data/rails-crud_actions.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rails-crud_actions}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Craig Buchek"]
+  s.date = %q{2009-01-25}
+  s.description = %q{Provides default CRUD actions for a Rails controller.}
+  s.email = ["craig@boochtek.com"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "PostInstall.txt", "README.rdoc"]
+  s.files = ["features/development.feature", "features/steps/common.rb", "features/steps/env.rb", "History.txt", "lib/rails-crud_actions.rb", "Manifest.txt", "PostInstall.txt", "rails-crud_actions.gemspec", "Rakefile", "README.rdoc", "spec/rails-crud_actions_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/rspec.rake", "tmp/tests.out"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/boochtek/rails-crud_actions}
+  s.post_install_message = %q{PostInstall.txt}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{rails-crud_actions}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Provides default CRUD actions for a Rails controller.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<newgem>, [">= 1.2.3"])
+      s.add_development_dependency(%q<hoe>, [">= 1.8.0"])
+    else
+      s.add_dependency(%q<newgem>, [">= 1.2.3"])
+      s.add_dependency(%q<hoe>, [">= 1.8.0"])
+    end
+  else
+    s.add_dependency(%q<newgem>, [">= 1.2.3"])
+    s.add_dependency(%q<hoe>, [">= 1.8.0"])
+  end
+end

data/spec/rails-crud_actions_spec.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+# Time to add your specs!
+# http://rspec.info/
+describe "Place your specs here" do
+  
+  it "find this spec in spec directory" do
+    violated "Be sure to write your specs"
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'rails-crud_actions'

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: boochtek-rails-crud_actions
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Craig Buchek
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-25 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: Provides default CRUD actions for a Rails controller.
+email: 
+- craig@boochtek.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+files: 
+- features/development.feature
+- features/steps/common.rb
+- features/steps/env.rb
+- History.txt
+- lib/rails-crud_actions.rb
+- Manifest.txt
+- PostInstall.txt
+- rails-crud_actions.gemspec
+- Rakefile
+- README.rdoc
+- spec/rails-crud_actions_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+- tmp/tests.out
+has_rdoc: true
+homepage: http://github.com/boochtek/rails-crud_actions
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc
+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: rails-crud_actions
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Provides default CRUD actions for a Rails controller.
+test_files: []
+