crudie 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 14b911b9a03850f5bd88718d356d56bfac76acb7
+  data.tar.gz: c91ce483e64ff7c08d644be9c22fe7b8e72fcdb4
+SHA512:
+  metadata.gz: 50806904485cdef551514b26883d2a5209b90a5871c1e360a406ce18b9be58edd2dfa315a71d67c1efeba6cfde740a9cd68256762a4c3926505be8e17bfe0a36
+  data.tar.gz: 28510bec736beb2d95f39ef3c6e61e24e87eed0707f58925c93dc2cf7a677d9c23a9eba9c0cbef2d39defc8c5335aeb173cfd26e4ba30879b82355b0c25a6c06

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    = 'Crudie'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/crudie.rb

@@ -0,0 +1,3 @@
+module Crudie
+  require 'crudie/controller_methods'
+end

data/lib/crudie/controller_methods.rb

@@ -0,0 +1,72 @@
+module Crudie
+  def self.included base
+
+    def base.crudie resource, options = {}
+      template_base = options[:template_base] || ""
+      template_extension = options[:template_extension] || "json.jbuilder"
+      resources = resource.to_s.pluralize
+
+      define_method(:template_path) do |action|
+        "#{template_base}#{resources}/#{action}.#{template_extension}"
+      end
+      private :template_path
+
+      # define method: `create`
+      # create resource under `crudie_context` using `crudie_params`
+      # render `#{template_base}#{resources}/create.#{template_extension}`
+      define_method(:create) do
+        instance = crudie_context.create(crudie_params)
+        if instance.valid?
+          instance_variable_set("@#{resource}".to_sym, instance)
+          render :template => template_path(:create)
+        else
+          render :status => 409,
+                 :json => { :reason => instance.errors.messages }
+        end
+      end
+
+      # define method: `index`
+      # list resources via `crudie_params`
+      # render `#{template_base}#{resources}/index.#{template_extension}`
+      define_method(:index) do
+        instance_variable_set("@#{resources}".to_sym, crudie_context)  
+        render :template => template_path(:index)
+      end
+
+      # define method: `show`
+      # show resource via `crudie_context.find(params[:id])`
+      # render `#{template_base}#{resources}/show.#{template_extension}`
+      define_method(:show) do
+        instance = crudie_context.find(params[:id])
+        instance_variable_set("@#{resource}".to_sym, instance)
+
+        render :template => template_path(:show)
+      end
+
+      # define method: `update`
+      # update resource via `crudie_context.find(params[:id])` with `crudie_params`
+      # render `#{template_base}#{resources}/update.#{template_extension}`
+      define_method(:update) do 
+        instance = crudie_context.find(params[:id])
+        updating_success = instance.update_attributes(crudie_params)
+
+        if updating_success
+          instance_variable_set("@#{resource}".to_sym, instance)
+          render :template => template_path(:update)
+        else
+          render :status => 409, :json => { :reason => instance.errors.messages }
+        end
+      end
+
+      # define method: `destroy`
+      # destroy resource via `crudie_context.find(params[:id])`
+      define_method(:destroy) do
+        instance = crudie_context.find(params[:id])
+        instance.destroy
+
+        render :json => { :status => 'destroy isntance ok' }
+      end
+
+    end
+  end
+end

data/lib/crudie/spec.rb

@@ -0,0 +1,155 @@
+# Crudie spec
+# usage:
+# RSpec.describe ProjectsController, :type => :controller do
+#   include Crudie::Spec
+#   include_crudie_spec_for :project, :context_name => :user
+# end
+module Crudie
+  module Spec
+
+    def self.included base
+      class << base
+        def include_crudie_spec_for resource, options = {}
+          context_name = options[:context_name]
+
+          describe "Crudie spec for `#{resource}`" do
+            let(:resource) { resource }
+            let(:resources) { resource.to_s.pluralize }
+            context 
+
+            test_create resource, context_name
+            test_index resource, context_name
+            test_show resource, context_name
+            test_update resource, context_name
+            test_destroy resource, context_name
+          end
+        end
+
+        private
+        def context
+          let(:crudie_context) { double(:crudie_context, :find => crudie_instance) }
+          let(:crudie_instance) { double(:crudie_instance, :valid? => true) }
+          before :each do
+            allow(controller).to receive(:crudie_context).and_return(crudie_context)
+          end
+        end
+
+        def test_index resource, context_name
+          describe 'GET :index' do
+            let(:params) do
+              prm = {}
+              prm["#{context_name}_id"] = 123 if context_name
+              prm
+            end
+            it "returns projects of user" do
+              get :index, params
+              expect(controller.instance_variable_get("@#{resources}")).to be(crudie_context)
+              expect(response.status).to eq 200
+            end
+          end
+          
+        end
+
+        def test_create resource, context_name
+          describe "POST :create" do
+            let(:params) do
+              prm = {}
+              prm["#{context_name}_id".to_sym] = 123 if context_name
+              prm[resource] = { 'key' => 'val' }
+              prm
+            end
+
+            before :each do
+              allow(controller).to receive(:crudie_params).and_return(params[resource])
+              expect(crudie_context).to receive(:create).with(params[resource]).and_return(crudie_instance)
+            end
+
+            it "creates a #{resource} under context" do
+              post :create, params
+            end
+
+            it "sets controller.@#{resource} as #{resource}" do
+              post :create, params
+              
+              expect(controller.instance_variable_get("@#{resource}")).to be(crudie_instance)
+            end
+
+            it "returns 409 if resource is not valid" do
+              allow(crudie_instance).to receive_messages(:valid? => false,
+                                                         :errors => double(:messages => 'the messages'))
+              post :create, params
+              expect(response.status).to eq 409
+            end
+          end
+        end
+
+
+        def test_show resource, context_name
+          describe "GET :show" do
+            let(:params) do
+              prm = { :id => 123 }
+              prm["#{context_name}_id"] = 123 if context_name
+              prm
+            end
+
+            it "shows the resource instance by id" do
+              get :show, params
+              expect(controller.instance_variable_get("@#{resource}")).to be crudie_instance 
+            end
+          end
+          
+        end
+
+        def test_update resource, context_name
+          describe "PUT :update" do
+            let(:params) do
+              prm = { :id => 123, resource => { 'key' => 'val' } }
+              prm["#{context_name}_id"] = 123 if context_name
+              prm
+            end
+            before :each do
+              allow(controller).to receive(:crudie_params).and_return(params[resource])
+            end
+
+            it "updates instance" do
+              expect(crudie_instance).to receive(:update_attributes).with(params[resource])
+                                                                    .and_return(true)
+              put :update, params
+              expect(controller.instance_variable_get("@#{resource}")).to be crudie_instance
+            end
+
+            it "render 409 if updating failed" do
+              expect(crudie_instance).to receive(:update_attributes)
+                                           .with(params[resource]).and_return(false)
+              expect(crudie_instance).to receive(:errors).and_return(double(:messages => 'the messages'))
+
+              put :update, params
+              expect(response.status).to eq 409
+            end
+            
+          end
+
+        end
+
+        def test_destroy resource, context_name
+          describe "DELETE :destroy" do
+            let(:params) do
+              prm = { :id => 123 }
+              prm["#{context_name}_id"] = 123 if context_name
+              prm
+            end
+            
+            it "destroy the instance" do
+              expect(crudie_instance).to receive(:destroy)
+              delete :destroy, params
+            end
+          end
+          
+        end
+
+      end
+    end
+
+
+  end
+end

data/lib/crudie/version.rb

@@ -0,0 +1,3 @@
+module Crudie
+  VERSION = "0.0.1"
+end

data/lib/tasks/crudie_tasks.rake

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

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: crudie
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yang-Hsing Lin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-24 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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A rails plugin to abstract CRUD api in controller
+email:
+- yanghsing.lin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- lib/crudie.rb
+- lib/crudie/controller_methods.rb
+- lib/crudie/spec.rb
+- lib/crudie/version.rb
+- lib/tasks/crudie_tasks.rake
+homepage: ''
+licenses:
+- MIT
+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.4.2
+signing_key: 
+specification_version: 4
+summary: A rails plugin to abstract CRUD api in controller
+test_files: []