crudie 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 14b911b9a03850f5bd88718d356d56bfac76acb7
4
+ data.tar.gz: c91ce483e64ff7c08d644be9c22fe7b8e72fcdb4
5
+ SHA512:
6
+ metadata.gz: 50806904485cdef551514b26883d2a5209b90a5871c1e360a406ce18b9be58edd2dfa315a71d67c1efeba6cfde740a9cd68256762a4c3926505be8e17bfe0a36
7
+ data.tar.gz: 28510bec736beb2d95f39ef3c6e61e24e87eed0707f58925c93dc2cf7a677d9c23a9eba9c0cbef2d39defc8c5335aeb173cfd26e4ba30879b82355b0c25a6c06
@@ -0,0 +1,20 @@
1
+ Copyright 2014 YOURNAME
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,21 @@
1
+ begin
2
+ require 'bundler/setup'
3
+ rescue LoadError
4
+ puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
5
+ end
6
+
7
+ require 'rdoc/task'
8
+
9
+ RDoc::Task.new(:rdoc) do |rdoc|
10
+ rdoc.rdoc_dir = 'rdoc'
11
+ rdoc.title = 'Crudie'
12
+ rdoc.options << '--line-numbers'
13
+ rdoc.rdoc_files.include('README.rdoc')
14
+ rdoc.rdoc_files.include('lib/**/*.rb')
15
+ end
16
+
17
+
18
+
19
+
20
+ Bundler::GemHelper.install_tasks
21
+
@@ -0,0 +1,3 @@
1
+ module Crudie
2
+ require 'crudie/controller_methods'
3
+ end
@@ -0,0 +1,72 @@
1
+ module Crudie
2
+ def self.included base
3
+
4
+ def base.crudie resource, options = {}
5
+ template_base = options[:template_base] || ""
6
+ template_extension = options[:template_extension] || "json.jbuilder"
7
+ resources = resource.to_s.pluralize
8
+
9
+ define_method(:template_path) do |action|
10
+ "#{template_base}#{resources}/#{action}.#{template_extension}"
11
+ end
12
+ private :template_path
13
+
14
+ # define method: `create`
15
+ # create resource under `crudie_context` using `crudie_params`
16
+ # render `#{template_base}#{resources}/create.#{template_extension}`
17
+ define_method(:create) do
18
+ instance = crudie_context.create(crudie_params)
19
+ if instance.valid?
20
+ instance_variable_set("@#{resource}".to_sym, instance)
21
+ render :template => template_path(:create)
22
+ else
23
+ render :status => 409,
24
+ :json => { :reason => instance.errors.messages }
25
+ end
26
+ end
27
+
28
+ # define method: `index`
29
+ # list resources via `crudie_params`
30
+ # render `#{template_base}#{resources}/index.#{template_extension}`
31
+ define_method(:index) do
32
+ instance_variable_set("@#{resources}".to_sym, crudie_context)
33
+ render :template => template_path(:index)
34
+ end
35
+
36
+ # define method: `show`
37
+ # show resource via `crudie_context.find(params[:id])`
38
+ # render `#{template_base}#{resources}/show.#{template_extension}`
39
+ define_method(:show) do
40
+ instance = crudie_context.find(params[:id])
41
+ instance_variable_set("@#{resource}".to_sym, instance)
42
+
43
+ render :template => template_path(:show)
44
+ end
45
+
46
+ # define method: `update`
47
+ # update resource via `crudie_context.find(params[:id])` with `crudie_params`
48
+ # render `#{template_base}#{resources}/update.#{template_extension}`
49
+ define_method(:update) do
50
+ instance = crudie_context.find(params[:id])
51
+ updating_success = instance.update_attributes(crudie_params)
52
+
53
+ if updating_success
54
+ instance_variable_set("@#{resource}".to_sym, instance)
55
+ render :template => template_path(:update)
56
+ else
57
+ render :status => 409, :json => { :reason => instance.errors.messages }
58
+ end
59
+ end
60
+
61
+ # define method: `destroy`
62
+ # destroy resource via `crudie_context.find(params[:id])`
63
+ define_method(:destroy) do
64
+ instance = crudie_context.find(params[:id])
65
+ instance.destroy
66
+
67
+ render :json => { :status => 'destroy isntance ok' }
68
+ end
69
+
70
+ end
71
+ end
72
+ end
@@ -0,0 +1,155 @@
1
+ # Crudie spec
2
+ # usage:
3
+ # RSpec.describe ProjectsController, :type => :controller do
4
+ # include Crudie::Spec
5
+ # include_crudie_spec_for :project, :context_name => :user
6
+ # end
7
+ module Crudie
8
+ module Spec
9
+
10
+ def self.included base
11
+ class << base
12
+ def include_crudie_spec_for resource, options = {}
13
+ context_name = options[:context_name]
14
+
15
+ describe "Crudie spec for `#{resource}`" do
16
+ let(:resource) { resource }
17
+ let(:resources) { resource.to_s.pluralize }
18
+ context
19
+
20
+ test_create resource, context_name
21
+ test_index resource, context_name
22
+ test_show resource, context_name
23
+ test_update resource, context_name
24
+ test_destroy resource, context_name
25
+ end
26
+ end
27
+
28
+ private
29
+ def context
30
+ let(:crudie_context) { double(:crudie_context, :find => crudie_instance) }
31
+ let(:crudie_instance) { double(:crudie_instance, :valid? => true) }
32
+ before :each do
33
+ allow(controller).to receive(:crudie_context).and_return(crudie_context)
34
+ end
35
+ end
36
+
37
+ def test_index resource, context_name
38
+ describe 'GET :index' do
39
+ let(:params) do
40
+ prm = {}
41
+ prm["#{context_name}_id"] = 123 if context_name
42
+ prm
43
+ end
44
+ it "returns projects of user" do
45
+ get :index, params
46
+ expect(controller.instance_variable_get("@#{resources}")).to be(crudie_context)
47
+ expect(response.status).to eq 200
48
+ end
49
+ end
50
+
51
+ end
52
+
53
+ def test_create resource, context_name
54
+ describe "POST :create" do
55
+ let(:params) do
56
+ prm = {}
57
+ prm["#{context_name}_id".to_sym] = 123 if context_name
58
+ prm[resource] = { 'key' => 'val' }
59
+ prm
60
+ end
61
+
62
+ before :each do
63
+ allow(controller).to receive(:crudie_params).and_return(params[resource])
64
+ expect(crudie_context).to receive(:create).with(params[resource]).and_return(crudie_instance)
65
+ end
66
+
67
+ it "creates a #{resource} under context" do
68
+ post :create, params
69
+ end
70
+
71
+ it "sets controller.@#{resource} as #{resource}" do
72
+ post :create, params
73
+
74
+ expect(controller.instance_variable_get("@#{resource}")).to be(crudie_instance)
75
+ end
76
+
77
+ it "returns 409 if resource is not valid" do
78
+ allow(crudie_instance).to receive_messages(:valid? => false,
79
+ :errors => double(:messages => 'the messages'))
80
+ post :create, params
81
+ expect(response.status).to eq 409
82
+ end
83
+ end
84
+ end
85
+
86
+
87
+ def test_show resource, context_name
88
+ describe "GET :show" do
89
+ let(:params) do
90
+ prm = { :id => 123 }
91
+ prm["#{context_name}_id"] = 123 if context_name
92
+ prm
93
+ end
94
+
95
+ it "shows the resource instance by id" do
96
+ get :show, params
97
+ expect(controller.instance_variable_get("@#{resource}")).to be crudie_instance
98
+ end
99
+ end
100
+
101
+ end
102
+
103
+ def test_update resource, context_name
104
+ describe "PUT :update" do
105
+ let(:params) do
106
+ prm = { :id => 123, resource => { 'key' => 'val' } }
107
+ prm["#{context_name}_id"] = 123 if context_name
108
+ prm
109
+ end
110
+ before :each do
111
+ allow(controller).to receive(:crudie_params).and_return(params[resource])
112
+ end
113
+
114
+ it "updates instance" do
115
+ expect(crudie_instance).to receive(:update_attributes).with(params[resource])
116
+ .and_return(true)
117
+ put :update, params
118
+ expect(controller.instance_variable_get("@#{resource}")).to be crudie_instance
119
+ end
120
+
121
+ it "render 409 if updating failed" do
122
+ expect(crudie_instance).to receive(:update_attributes)
123
+ .with(params[resource]).and_return(false)
124
+ expect(crudie_instance).to receive(:errors).and_return(double(:messages => 'the messages'))
125
+
126
+ put :update, params
127
+ expect(response.status).to eq 409
128
+ end
129
+
130
+ end
131
+
132
+ end
133
+
134
+ def test_destroy resource, context_name
135
+ describe "DELETE :destroy" do
136
+ let(:params) do
137
+ prm = { :id => 123 }
138
+ prm["#{context_name}_id"] = 123 if context_name
139
+ prm
140
+ end
141
+
142
+ it "destroy the instance" do
143
+ expect(crudie_instance).to receive(:destroy)
144
+ delete :destroy, params
145
+ end
146
+ end
147
+
148
+ end
149
+
150
+ end
151
+ end
152
+
153
+
154
+ end
155
+ end
@@ -0,0 +1,3 @@
1
+ module Crudie
2
+ VERSION = "0.0.1"
3
+ end
@@ -0,0 +1,4 @@
1
+ # desc "Explaining what the task does"
2
+ # task :crudie do
3
+ # # Task goes here
4
+ # end
metadata ADDED
@@ -0,0 +1,93 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: crudie
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Yang-Hsing Lin
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2014-12-24 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: rails
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - '>='
18
+ - !ruby/object:Gem::Version
19
+ version: 4.0.0
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - '>='
25
+ - !ruby/object:Gem::Version
26
+ version: 4.0.0
27
+ - !ruby/object:Gem::Dependency
28
+ name: sqlite3
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - '>='
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - '>='
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec-rails
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - '>='
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - '>='
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ description: A rails plugin to abstract CRUD api in controller
56
+ email:
57
+ - yanghsing.lin@gmail.com
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - MIT-LICENSE
63
+ - Rakefile
64
+ - lib/crudie.rb
65
+ - lib/crudie/controller_methods.rb
66
+ - lib/crudie/spec.rb
67
+ - lib/crudie/version.rb
68
+ - lib/tasks/crudie_tasks.rake
69
+ homepage: ''
70
+ licenses:
71
+ - MIT
72
+ metadata: {}
73
+ post_install_message:
74
+ rdoc_options: []
75
+ require_paths:
76
+ - lib
77
+ required_ruby_version: !ruby/object:Gem::Requirement
78
+ requirements:
79
+ - - '>='
80
+ - !ruby/object:Gem::Version
81
+ version: '0'
82
+ required_rubygems_version: !ruby/object:Gem::Requirement
83
+ requirements:
84
+ - - '>='
85
+ - !ruby/object:Gem::Version
86
+ version: '0'
87
+ requirements: []
88
+ rubyforge_project:
89
+ rubygems_version: 2.4.2
90
+ signing_key:
91
+ specification_version: 4
92
+ summary: A rails plugin to abstract CRUD api in controller
93
+ test_files: []