cruddy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 90532271103c41782049c9aacbf400c7bb0f105f
+  data.tar.gz: e80c4957c57cc26a7608fb9e40d877525513bd44
+SHA512:
+  metadata.gz: b19f3d7791769e403a280a21cea95c9fa2143a7af369eccfd3d84d0183e44012acd512833b654a0a32c4ba6d1400979cd7679982011195ec31dbea17ba249770
+  data.tar.gz: b71a8574acccce1523c931e7c39776e687efcffa7468f12184683a3aa8b2b21087b5828943928081f12921f57f87d5d2f50df7f1ba4c6f580255a6dfa25d1ebd

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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,21 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Cruddy'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/cruddy.rb

@@ -0,0 +1,4 @@
+require "cruddy/controller"
+
+module Cruddy
+end

data/lib/cruddy/controller.rb

@@ -0,0 +1,127 @@
+module Cruddy::Controller
+  module ClassMethods
+
+  end
+
+  module InstanceMethods
+    # the class this controller manages
+    def resource_class
+      controller_name.classify.constantize
+    end
+
+    # the name of the resource collection
+    def resource_collection_name
+      controller_name
+    end
+
+    # the name of the singular resource
+    def resource_instance_name
+      controller_name.singularize
+    end
+
+    # get instance variable for singluar resource instance
+    def resource
+      instance_variable_get("@#{resource_instance_name}")
+    end
+
+    # set instance variable for singluar resource instance
+    def resource=(resource)
+      instance_variable_set("@#{resource_instance_name}", resource)
+    end
+
+    # get instance variable for collection of resource instances
+    def resources
+      instance_variable_get("@#{resource_collection_name}")
+    end
+
+    # set instance variable for collection of resource instances
+    def resources=(collection)
+      instance_variable_set("@#{resource_collection_name}", collection)
+    end
+
+    # require the resource and permit all params by default
+    def resource_params
+      params.require(resource_instance_name).permit!
+    end
+
+    # get the path to a singular resource
+    def resource_path(resource)
+      send("#{resource_instance_name}_path", resource)
+    end
+
+    # get the path to index resources
+    def resources_path
+      send("#{resource_collection_name}_path")
+    end
+
+    def find_resource_instance
+      self.resource = resource_class.find(params[:id])
+    end
+
+    def find_resource_collection
+      self.resources = resource_class.all
+    end
+
+    # index action
+    def index
+      find_resource_collection
+      respond_with resources
+    end
+
+    # show action
+    def show
+      find_resource_instance
+      respond_with resource
+    end
+
+    # new action
+    def new
+      self.resource = resource_class.new
+      respond_with resource
+    end
+
+    # create action
+    def create
+      self.resource = resource_class.new(resource_params)
+
+      if resource.save
+        redirect_to resource_path(resource)
+      else
+        respond_with(resource) do |format|
+          format.html { render :new }
+        end
+      end
+    end
+
+    # edit action
+    def edit
+      find_resource_instance
+      respond_with resource
+    end
+
+    # update action
+    def update
+      find_resource_instance
+
+      if resource.update_attributes(resource_params)
+        redirect_to resource_path(resource)
+      else
+        respond_with(resource) do |format|
+          format.html { render :edit }
+        end
+      end
+    end
+
+    # destroy action
+    def destroy
+      find_resource_instance
+      resource.destroy
+      redirect_to resources_path
+    end
+  end
+
+  def self.included(receiver)
+    receiver.extend         ClassMethods
+    receiver.send :include, InstanceMethods
+  end
+end

data/lib/cruddy/spec_support.rb

@@ -0,0 +1,2 @@
+# require all spec support files
+Dir[File.join(File.dirname(__FILE__), 'spec_support', '*.rb')].each {|file| require file }

data/lib/cruddy/spec_support/create_examples.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+shared_examples "cruddy::controller#create" do
+  let(:resource_instance_name) { resource_class.to_s.downcase }
+  let(:resource_collection_name) { resource_instance_name.pluralize }
+
+  describe "POST create" do
+    context "when saved successfully" do
+      let(:instance) { mock_model resource_class, valid_resource_params.merge({save: true}) }
+      let(:instance_path_method) { "#{resource_instance_name}_path" }
+      let(:instance_path) { send(instance_path_method, instance) }
+
+      before do
+        resource_class.stub(:new).with(valid_resource_params) { instance }
+      end
+
+      it "assigns the newly created resource" do
+        post :create, resource_instance_name => valid_resource_params
+        assigns(resource_instance_name).should eq(instance)
+      end
+
+      it "redirects to the newly created resource" do
+        post :create, resource_instance_name => valid_resource_params
+        response.should redirect_to(instance_path)
+      end
+    end
+
+    context "when save fails" do
+      let(:instance) { mock_model resource_class, valid_resource_params.merge({save: false}) }
+      let(:instance_path_method) { "#{resource_instance_name}_path" }
+
+      before do
+        resource_class.stub(:new).with(valid_resource_params) { instance }
+      end
+
+      it "assigns the newly created resource" do
+        post :create, resource_instance_name => valid_resource_params
+        assigns(resource_instance_name).should eq(instance)
+      end
+
+      it "renders the new view" do
+        post :create, resource_instance_name => valid_resource_params
+        response.should render_template(:new)
+      end
+    end
+  end
+end

data/lib/cruddy/spec_support/cruddy_examples.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+shared_examples "cruddy::controller" do
+  # Create
+  it_behaves_like "cruddy::controller#new"
+  it_behaves_like "cruddy::controller#create"
+
+  # Read
+  it_behaves_like "cruddy::controller#index"
+  it_behaves_like "cruddy::controller#show"
+
+  # Update
+  it_behaves_like "cruddy::controller#edit"
+  it_behaves_like "cruddy::controller#update"
+
+  # Delete
+  it_behaves_like "cruddy::controller#destroy"
+end

data/lib/cruddy/spec_support/destroy_examples.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+shared_examples "cruddy::controller#destroy" do
+  let(:resource_instance_name) { resource_class.to_s.downcase }
+  let(:resource_collection_name) { resource_instance_name.pluralize }
+
+  describe "DELETE destroy" do
+    let(:instance) { mock_model resource_class, destroy: true }
+    let(:collection_path_method) { "#{resource_collection_name}_path" }
+    let(:collection_path) { send(collection_path_method) }
+
+    before do
+      resource_class.stub(:find).with(instance.id.to_s) { instance }
+    end
+
+    it "finds the resource instance" do
+      delete :destroy, id: instance.id
+      assigns(resource_instance_name).should eq(instance)
+    end
+
+    it "destroys the resource" do
+      delete :destroy, id: instance.id
+      expect(instance).to have_received(:destroy)
+    end
+
+    it "redirects to the resource collection path" do
+      delete :destroy, id: instance.id
+      response.should redirect_to(collection_path)
+    end
+  end
+end

data/lib/cruddy/spec_support/edit_examples.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+shared_examples "cruddy::controller#edit" do
+  let(:resource_instance_name) { resource_class.to_s.downcase }
+  let(:resource_collection_name) { resource_instance_name.pluralize }
+
+  describe "GET edit" do
+    let(:instance) { mock_model resource_class }
+
+    before do
+      resource_class.stub(:find).with(instance.id.to_s) { instance }
+    end
+
+    it "finds the instance" do
+      get :edit, id: instance.id
+      assigns(resource_instance_name).should eq(instance)
+    end
+
+    it "renders the edit view" do
+      get :edit, id: instance.id
+      response.should render_template(:edit)
+    end
+  end
+end

data/lib/cruddy/spec_support/index_examples.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+shared_examples "cruddy::controller#index" do
+  let(:resource_instance_name) { resource_class.to_s.downcase }
+  let(:resource_collection_name) { resource_instance_name.pluralize }
+
+  describe "GET index" do
+    let(:instance) { mock_model resource_class }
+
+    before do
+      resource_class.stub(:all) { [instance] }
+    end
+
+    it "finds the collection" do
+      get :index
+      assigns(resource_collection_name).should eq(resource_class.all)
+    end
+
+    it "renders the index view" do
+      get :index
+      response.should render_template(:index)
+    end
+  end
+end

data/lib/cruddy/spec_support/new_examples.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+shared_examples "cruddy::controller#new" do
+  let(:resource_instance_name) { resource_class.to_s.downcase }
+  let(:resource_collection_name) { resource_instance_name.pluralize }
+
+  describe "GET new" do
+    it "initializes a resource instance" do
+      get :new
+      assigns(resource_instance_name).should be_a_kind_of(resource_class)
+      assigns(resource_instance_name).should be_new_record
+    end
+
+    it "renders the new view" do
+      get :new
+      response.should render_template(:new)
+    end
+  end
+end

data/lib/cruddy/spec_support/show_examples.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+shared_examples "cruddy::controller#show" do
+  let(:resource_instance_name) { resource_class.to_s.downcase }
+  let(:resource_collection_name) { resource_instance_name.pluralize }
+
+  describe "GET show" do
+    let(:instance) { mock_model resource_class }
+
+    before do
+      resource_class.stub(:find).with(instance.id.to_s) { instance }
+    end
+
+    it "finds the instance" do
+      get :show, id: instance.id
+      assigns(resource_instance_name).should eq(instance)
+    end
+
+    it "renders the show view" do
+      get :show, id: instance.id
+      response.should render_template(:show)
+    end
+  end
+end

data/lib/cruddy/spec_support/update_examples.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+shared_examples "cruddy::controller#update" do
+  let(:resource_instance_name) { resource_class.to_s.downcase }
+  let(:resource_collection_name) { resource_instance_name.pluralize }
+
+  describe "PATCH update" do
+    let(:instance) { mock_model resource_class, update_attributes: true }
+    let(:instance_path_method) { "#{resource_instance_name}_path" }
+    let(:instance_path) { send(instance_path_method, instance) }
+
+    before do
+      resource_class.stub(:find).with(instance.id.to_s) { instance }
+    end
+
+    it "finds the instance" do
+      patch :update, id: instance.id, resource_instance_name => valid_resource_params
+      assigns(resource_instance_name).should eq(instance)
+    end
+
+    context "when saved successfully" do
+      before do
+        instance.stub(:update_attributes).with(valid_resource_params) { true }
+      end
+
+      it "redirects to the newly created resource" do
+        patch :update, id: instance.id, resource_instance_name => valid_resource_params
+        response.should redirect_to(instance_path)
+      end
+    end
+
+    context "when save fails" do
+      before do
+        instance.stub(:update_attributes).with(valid_resource_params) { false }
+      end
+
+      it "renders the edit view" do
+        patch :update, id: instance.id, resource_instance_name => valid_resource_params
+        response.should render_template(:edit)
+      end
+    end
+  end
+end

data/lib/cruddy/version.rb

@@ -0,0 +1,3 @@
+module Cruddy
+  VERSION = "0.1.0"
+end

data/lib/tasks/cruddy_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :cruddy do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: cruddy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex Rehberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: Cruddy is intended to DRY up basic CRUD in rails controllers.
+email:
+- hi@alexrehberg.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- lib/cruddy.rb
+- lib/cruddy/controller.rb
+- lib/cruddy/spec_support.rb
+- lib/cruddy/spec_support/create_examples.rb
+- lib/cruddy/spec_support/cruddy_examples.rb
+- lib/cruddy/spec_support/destroy_examples.rb
+- lib/cruddy/spec_support/edit_examples.rb
+- lib/cruddy/spec_support/index_examples.rb
+- lib/cruddy/spec_support/new_examples.rb
+- lib/cruddy/spec_support/show_examples.rb
+- lib/cruddy/spec_support/update_examples.rb
+- lib/cruddy/version.rb
+- lib/tasks/cruddy_tasks.rake
+homepage: http://github.com/arehberg/cruddy
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Basic crud stuff for rails
+test_files: []