crudie 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f3f88d5b9eec16f4c0fba4969a5f7604270142e
-  data.tar.gz: f2f70f61ee00c11db2714c4dd57c9716ece759eb
+  metadata.gz: 57c9008695012cf6225661e85f53a2eede894431
+  data.tar.gz: e627a68ce7147a58d357f1a7bc4024ba6799ea6c
 SHA512:
-  metadata.gz: a59c7eeaaa56ade9b4964c0512b4d20b6df4defd679f30445e902d592382e6742e139b99c4b6d7ffc4986bd758c5f6beaff87d9ae11b066ff57cc107a427ac09
-  data.tar.gz: 41367bb695c77c8eae7a08cff457fcb598e8ddacafb132004fb69d5310237a2ec5f1afe7e169209dcfb9a015796e21e24d58549915e6e425c651f73f1dbf74d9
+  metadata.gz: 624b8ac1074195d0b9e139fadd5cd80e1e9b1997d0723b091e711cc5b5d632765c26a1853f612edf00c45d54f438a624c7a2e78c67ab6b0939578f014f41ca55
+  data.tar.gz: cc4d2bce18d21f29acd4cb44c8e647d060418c1098ebd51b1866b62c8618ab4d4993a2d5585f08a6691c79b6bc8493e5bbac22912fd4f238605c94ab5efb7005

data/lib/crudie/spec.rb

@@ -1,155 +1,15 @@
 # Crudie spec
+#
+# Crudie::Spec::Unit
 # 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]
-
-          methods_to_test = options[:only] || [ :create, :index, :update, :show, :destroy ]
-          excluded_methods = options[:except] || []
-          methods_to_test = methods_to_test - excluded_methods
-
-          describe "Crudie spec for `#{resource}`" do
-            let(:resource) { resource }
-            let(:resources) { resource.to_s.pluralize }
-            context 
-
-            methods_to_test.each { |m| send("test_#{m}".to_sym, 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
-
-
+    require 'crudie/spec/unit'
+    require 'crudie/spec/acceptance'
   end
 end

data/lib/crudie/spec/acceptance.rb

@@ -0,0 +1,181 @@
+# Acceptance spec helper
+# Usage:
+# 1. for resource without parent:
+# include Crudie::Spec::Acceptance
+# include_acceptance_spec_for :resource => {
+#                               :name => :user,
+#                               :creator => Proc.new {|index| User.create :name => index },
+#                               :context => Proc.new { User.all }
+#                             },
+#                             :parameters => {
+#                               :name => {
+#                                 :desc => 'user name',
+#                                 :value => 'the new user name',
+#                                 :options => {
+#                                   :scope => :user,
+#                                   :required => true
+#                                 }
+#                               }
+#                             }
+#
+# 2. for resource with parent:
+# include Crudie::Spec::Acceptance
+# include_acceptance_spec_for :parent => {
+#                               :name => :user,
+#                               :creator => Proc.new { User.create :name => 'jack' }
+#                             },
+#                             :resource => {
+#                               :name => :project,
+#                               :creator => Proc.new {|i, user| user.projects.create :name => i },
+#                               :context => Proc.new {|parent| parent.projects }
+#                             },
+#                             :parameters => {
+#                               :name => {
+#                                 :desc => 'project name',
+#                                 :value => 'the new project name',
+#                                 :options => {
+#                                   :scope => :project,
+#                                   :required => true
+#                                 }
+#                               }
+#                             }
+
+module Crudie::Spec::Acceptance
+  def self.included base
+    class << base
+      def include_acceptance_spec_for options 
+        resource_names = options[:resource][:name].to_s.pluralize
+        resource_name_id = "#{options[:resource][:name]}_id"
+        resource_creator = options[:resource][:creator]
+        resource_context = options[:resource][:context]
+
+        request_parameters = options[:parameters]
+
+        parent_exists = ! options[:parent].nil?
+
+        if parent_exists
+          parent_names = options[:parent][:name].to_s.pluralize
+          parent_creator = options[:parent][:creator]
+          parent_name_id = "#{options[:parent][:name]}_id"
+
+          plural_url = "/#{parent_names}/:#{parent_name_id}/#{resource_names}"
+          singular_url = "#{plural_url}/:#{resource_name_id}"
+
+          let(:parent_instance) { self.instance_eval &parent_creator}
+          let(parent_name_id) { parent_instance.id }
+        else
+          plural_url = "/#{resource_names}"
+          singular_url = "#{plural_url}/:#{resource_name_id}"
+        end
+
+        only_actions = options[:only] || [ :index, :show, :update, :destroy, :create ]
+        except = options[:except] || []
+        actions = only_actions - except
+
+        shared_context 'with_single_resource_instance' do 
+          let!(:resource_instance) do
+            if parent_exists
+              resource_creator.call(1, parent_instance)
+            else
+              resource_creator.call(1)
+            end
+          end
+        end
+
+        shared_context 'with_parameters' do
+          request_parameters.each do |key, detail|
+            parameter key, detail[:desc], detail[:options]
+            let(key) { detail[:value] }
+          end
+          let(resource_name_id) { resource_instance.id }
+        end
+
+        # index spec
+        if actions.include?(:index)
+          get plural_url do
+            let!(:resources) do
+              3.times do |i|
+                parent_exists ? 
+                  resource_creator.call(i, parent_instance) : 
+                  resource_creator.call(i)
+              end
+            end
+
+            example 'Index' do
+              do_request
+              expect(response_status).to eq 200
+              expect(JSON.parse(response_body).count).to eq 3
+            end
+          end
+        end
+
+        # show spec
+        if actions.include?(:show)
+          get singular_url do
+            include_context 'with_single_resource_instance'
+            let(resource_name_id) { resource_instance.id }
+
+            example 'Show' do
+              do_request
+              expect(JSON.parse(response_body)['id']).to eq(resource_instance.id)
+            end
+          end
+        end
+
+        # Create spec
+        if actions.include?(:create)
+          post plural_url do
+            include_context 'with_parameters'
+            example 'Create' do
+              do_request
+
+              if parent_exists
+                expect(resource_context.call(parent_instance).count).to eq 1
+              else
+                expect(resource_context.call.count).to eq 1
+              end
+
+            end
+          end
+        end
+
+        # Update spec
+        if actions.include?(:update)
+          put singular_url do
+            include_context 'with_single_resource_instance'
+            include_context 'with_parameters'
+
+            example 'Updating' do
+              do_request
+
+              resource_instance.reload
+              request_parameters.each do |key, val|
+                expect(resource_instance.send(key)).to eq(send(key))
+              end
+            end
+          end
+        end
+
+        # destroy spec
+        if actions.include?(:destroy)
+          delete singular_url do
+            include_context 'with_single_resource_instance'
+            let(resource_name_id) { resource_instance.id }
+
+            example 'Deletion' do
+              do_request
+              if parent_exists
+                expect(resource_context.call(parent_instance)
+                                       .where(:id => resource_instance.id)).to be_empty
+              else
+                expect(resource_context.call
+                                       .where(:id => resource_instance.id)).to be_empty
+              end
+            end
+          end
+        end
+        
+      end
+    end
+  end
+end

data/lib/crudie/spec/unit.rb

@@ -0,0 +1,150 @@
+# Crudie spec
+# usage:
+# RSpec.describe ProjectsController, :type => :controller do
+#   include Crudie::Spec
+#   include_crudie_spec_for :project, :context_name => :user
+# end
+module Crudie::Spec::Unit
+  def self.included base
+    class << base
+      def include_crudie_spec_for resource, options = {}
+        context_name = options[:context_name]
+
+        methods_to_test = options[:only] || [ :create, :index, :update, :show, :destroy ]
+        excluded_methods = options[:except] || []
+        methods_to_test = methods_to_test - excluded_methods
+
+        describe "Crudie spec for `#{resource}`" do
+          let(:resource) { resource }
+          let(:resources) { resource.to_s.pluralize }
+          context 
+
+          methods_to_test.each { |m| send("test_#{m}".to_sym, 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

data/lib/crudie/version.rb

@@ -1,3 +1,3 @@
 module Crudie
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crudie
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Yang-Hsing Lin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-26 00:00:00.000000000 Z
+date: 2015-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,6 +52,48 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_api_documentation
+  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: factory_girl_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'
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  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
@@ -64,6 +106,8 @@ files:
 - lib/crudie.rb
 - lib/crudie/controller_methods.rb
 - lib/crudie/spec.rb
+- lib/crudie/spec/acceptance.rb
+- lib/crudie/spec/unit.rb
 - lib/crudie/version.rb
 - lib/tasks/crudie_tasks.rake
 homepage: ''