enum_attribute 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
data/.document ADDED
@@ -0,0 +1,5 @@
1
+ lib/**/*.rb
2
+ bin/*
3
+ -
4
+ features/**/*.feature
5
+ LICENSE.txt
data/.rspec ADDED
@@ -0,0 +1 @@
1
+ --color
data/.rvmrc ADDED
@@ -0,0 +1 @@
1
+ rvm 1.9.2-head@rails310rc4
data/Gemfile ADDED
@@ -0,0 +1,14 @@
1
+ source "http://rubygems.org"
2
+ # Add dependencies required to use your gem here.
3
+ # Example:
4
+ # gem "activesupport", ">= 2.3.5"
5
+
6
+ # Add dependencies to develop your gem here.
7
+ # Include everything needed to run rake, tests, features, etc.
8
+ group :development do
9
+ gem "rspec", "~> 2.3.0"
10
+ gem "yard", "~> 0.6.0"
11
+ gem "bundler", "~> 1.0.0"
12
+ gem "jeweler", "~> 1.6.4"
13
+ gem "rcov", ">= 0"
14
+ end
data/Gemfile.lock ADDED
@@ -0,0 +1,30 @@
1
+ GEM
2
+ remote: http://rubygems.org/
3
+ specs:
4
+ diff-lcs (1.1.2)
5
+ git (1.2.5)
6
+ jeweler (1.6.4)
7
+ bundler (~> 1.0)
8
+ git (>= 1.2.5)
9
+ rake
10
+ rake (0.9.2)
11
+ rcov (0.9.9)
12
+ rspec (2.3.0)
13
+ rspec-core (~> 2.3.0)
14
+ rspec-expectations (~> 2.3.0)
15
+ rspec-mocks (~> 2.3.0)
16
+ rspec-core (2.3.1)
17
+ rspec-expectations (2.3.0)
18
+ diff-lcs (~> 1.1.2)
19
+ rspec-mocks (2.3.0)
20
+ yard (0.6.8)
21
+
22
+ PLATFORMS
23
+ ruby
24
+
25
+ DEPENDENCIES
26
+ bundler (~> 1.0.0)
27
+ jeweler (~> 1.6.4)
28
+ rcov
29
+ rspec (~> 2.3.0)
30
+ yard (~> 0.6.0)
data/LICENSE.txt ADDED
@@ -0,0 +1,20 @@
1
+ Copyright (c) 2011 Eiji Kosaki
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.
data/README.md ADDED
@@ -0,0 +1,48 @@
1
+ enum_attribute
2
+ --------------
3
+
4
+ * If you settin up enum_attribute to existed your method,
5
+ * add helpful method automatically.
6
+ * It's for good to input type(select,checkbox,radio)
7
+ * indication with I18n
8
+
9
+
10
+
11
+ Installing
12
+ ----------
13
+ To install enum_attribute, use the following command:
14
+
15
+ $ gem install enum_attribute
16
+
17
+ or write Gemfile and "bundle install"
18
+
19
+ $ gem 'enum_attribute', :git=>'https://github.com/eijik/enum_attribute.git'
20
+
21
+
22
+ Usage
23
+ -----
24
+ #add in your model
25
+ include EnumAttribute
26
+
27
+ #setting in a Aaa model
28
+ #your_method is already defined.
29
+ #ex.
30
+ enum_attribute :(your_method), ['a','b','c']
31
+
32
+
33
+
34
+ == Contributing to enum_attribute
35
+
36
+ * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
37
+ * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
38
+ * Fork the project
39
+ * Start a feature/bugfix branch
40
+ * Commit and push until you are happy with your contribution
41
+ * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
42
+ * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
43
+
44
+ == Copyright
45
+
46
+ Copyright (c) 2011 Eiji Kosaki. See LICENSE.txt for
47
+ further details.
48
+
data/Rakefile ADDED
@@ -0,0 +1,42 @@
1
+ # encoding: utf-8
2
+
3
+ require 'rubygems'
4
+ require 'bundler'
5
+ begin
6
+ Bundler.setup(:default, :development)
7
+ rescue Bundler::BundlerError => e
8
+ $stderr.puts e.message
9
+ $stderr.puts "Run `bundle install` to install missing gems"
10
+ exit e.status_code
11
+ end
12
+ require 'rake'
13
+
14
+ require 'jeweler'
15
+ Jeweler::Tasks.new do |gem|
16
+ # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
17
+ gem.name = "enum_attribute"
18
+ gem.homepage = "http://github.com/eijik/enum_attribute"
19
+ gem.license = "MIT"
20
+ gem.summary = %Q{Add helper selection method for model class}
21
+ gem.description = %Q{I'm going to describe detail later...}
22
+ gem.email = "monkeytohuman@gmail.com"
23
+ gem.authors = ["Eiji Kosaki"]
24
+ # dependencies defined in Gemfile
25
+ end
26
+ Jeweler::RubygemsDotOrgTasks.new
27
+
28
+ require 'rspec/core'
29
+ require 'rspec/core/rake_task'
30
+ RSpec::Core::RakeTask.new(:spec) do |spec|
31
+ spec.pattern = FileList['spec/**/*_spec.rb']
32
+ end
33
+
34
+ RSpec::Core::RakeTask.new(:rcov) do |spec|
35
+ spec.pattern = 'spec/**/*_spec.rb'
36
+ spec.rcov = true
37
+ end
38
+
39
+ task :default => :spec
40
+
41
+ require 'yard'
42
+ YARD::Rake::YardocTask.new
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 0.0.1
@@ -0,0 +1,64 @@
1
+ # Generated by jeweler
2
+ # DO NOT EDIT THIS FILE DIRECTLY
3
+ # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
4
+ # -*- encoding: utf-8 -*-
5
+
6
+ Gem::Specification.new do |s|
7
+ s.name = %q{enum_attribute}
8
+ s.version = "0.0.1"
9
+
10
+ s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
11
+ s.authors = [%q{Eiji Kosaki}]
12
+ s.date = %q{2011-07-16}
13
+ s.description = %q{I'm going to describe detail later...}
14
+ s.email = %q{monkeytohuman@gmail.com}
15
+ s.extra_rdoc_files = [
16
+ "LICENSE.txt",
17
+ "README.md"
18
+ ]
19
+ s.files = [
20
+ ".document",
21
+ ".rspec",
22
+ ".rvmrc",
23
+ "Gemfile",
24
+ "Gemfile.lock",
25
+ "LICENSE.txt",
26
+ "README.md",
27
+ "Rakefile",
28
+ "VERSION",
29
+ "enum_attribute.gemspec",
30
+ "lib/enum_attribute.rb",
31
+ "spec/enum_attribute_spec.rb",
32
+ "spec/spec_helper.rb"
33
+ ]
34
+ s.homepage = %q{http://github.com/eijik/enum_attribute}
35
+ s.licenses = [%q{MIT}]
36
+ s.require_paths = [%q{lib}]
37
+ s.rubygems_version = %q{1.8.2}
38
+ s.summary = %q{Add helper selection method for model class}
39
+
40
+ if s.respond_to? :specification_version then
41
+ s.specification_version = 3
42
+
43
+ if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
44
+ s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
45
+ s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
46
+ s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
47
+ s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
48
+ s.add_development_dependency(%q<rcov>, [">= 0"])
49
+ else
50
+ s.add_dependency(%q<rspec>, ["~> 2.3.0"])
51
+ s.add_dependency(%q<yard>, ["~> 0.6.0"])
52
+ s.add_dependency(%q<bundler>, ["~> 1.0.0"])
53
+ s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
54
+ s.add_dependency(%q<rcov>, [">= 0"])
55
+ end
56
+ else
57
+ s.add_dependency(%q<rspec>, ["~> 2.3.0"])
58
+ s.add_dependency(%q<yard>, ["~> 0.6.0"])
59
+ s.add_dependency(%q<bundler>, ["~> 1.0.0"])
60
+ s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
61
+ s.add_dependency(%q<rcov>, [">= 0"])
62
+ end
63
+ end
64
+
@@ -0,0 +1,168 @@
1
+
2
+ # usage
3
+ # #add in your model
4
+ # include EnumAttribute
5
+ #
6
+ # #seting in a Aaa model
7
+ # enum_attribute :test, ['a','b','c']
8
+ #
9
+ # ex.
10
+ # class methods is defined.
11
+ # Aaa.tests => ['a','b','c']
12
+ # Aaa.test_names => [ t('activerecord.attributes.aaa.tests.a'),
13
+ # t('activerecord.attributes.aaa.tests.b'),
14
+ # t('activerecord.attributes.aaa.tests.c') ]
15
+ #
16
+ # Aaa.test_name('a') => t('activerecord.attributes.aaa.tests.a')
17
+ #
18
+ # Aaa.test_pairs => [[t('activerecord.attributes.aaa.tests.a'),a],
19
+ # [t('activerecord.attributes.aaa.tests.b'),b],
20
+ # [t('activerecord.attributes.aaa.tests.c'),c]]
21
+ #
22
+ # test_pairs method is useful for select_tag
23
+ # select @aaa, Aaa.test_pairs
24
+ #
25
+ # instance methods also is defined.
26
+ # @aaa = Aaa.new(:test=>'a')
27
+ # @aaa.test_name => t('activerecord.attributes.aaa.tests.a')
28
+ #
29
+ #
30
+ # @params [Hash] options
31
+ # @options options [boolean] :number(false)
32
+ # if true, (name)_pairs method return number in 2nd array
33
+ # and change column name :column => (name)_id automatically!
34
+ # It will be useful for select type
35
+ # ex.
36
+ # seting in a model
37
+ # enum_attribute :test, ['a','b','c'] :number => true
38
+ # you can get
39
+ # object.test_pairs => [[a,1],[b,2],[c,3]]
40
+ #
41
+ #
42
+ # @options options [string] :column_name(false) attached column name in table of DB
43
+ #
44
+ # ex. :column =>
45
+ # it will be set when name and column name is difference
46
+ #
47
+ # @options options [boolean] :i18n(true)
48
+ # if i18n == false ,just return raw data
49
+ #
50
+ module EnumAttribute
51
+ def self.included target
52
+ target.class_eval do
53
+ extend EnumAttribute::ClassMethods
54
+ end
55
+ end
56
+
57
+ module ClassMethods
58
+ def enum_attribute name, values, opts={:number=>false,:colum_name=>false,:i18n=>true}
59
+ raise "Values should be given as Enumerable" unless values.is_a?(Enumerable)
60
+ values = values.map(&:to_s)
61
+ #validates_inclusion_of __send__(name), :in=>values unless opts[:skip_validation]
62
+
63
+ pluralized = name.to_s.pluralize
64
+
65
+ extend Module.new{
66
+ define_method pluralized do
67
+ values
68
+ end
69
+ define_method "#{name}_names" do
70
+ if opts[:i18n] == false
71
+ values
72
+ else
73
+ values.map{|n|self.i18nt(n,pluralized)}
74
+ end
75
+ end
76
+ define_method "#{name}_pairs" do
77
+ if opts[:number]
78
+ values.each_with_index.map{|n,i|[ self.i18nt(n,pluralized), i + 1]}
79
+ else
80
+ values.map{|n|[ self.i18nt(n,pluralized), n]}
81
+ end
82
+ end
83
+ define_method "#{name}_name" do |col|
84
+ return "" unless col
85
+ if col.to_i==0
86
+ [self.i18nt(col,pluralized)]
87
+ else
88
+ [self.i18nt(values[col - 1],pluralized)]
89
+ end
90
+ end
91
+ def i18nt(value,pluralized)
92
+ return "" unless value
93
+ #I18n.t("models.#{self.model_name.to_s.underscore}.#{pluralized}.#{value}")
94
+ i18n_scope = "activerecord"
95
+ i18n_scope = self.i18n_scope.to_s if defined?(self.i18n_scope) #rails2 support i18n_scope
96
+ I18n.t("#{i18n_scope}.attributes.#{self.model_name.to_s.underscore}.#{pluralized}.#{value}")
97
+ end
98
+ }
99
+
100
+ # foo.val_seed
101
+ define_method "#{name}_seed" do
102
+ column_name = name
103
+ column_name = opts[:column_name] if opts[:column_name]
104
+ if opts[:number]
105
+ if __send__(column_name) #reject nil in column
106
+ values[__send__(column_name) - 1]
107
+ else
108
+ ""
109
+ end
110
+ else
111
+ column_name
112
+ end
113
+ end
114
+
115
+
116
+ # if locale is just variable,it'll cause to error
117
+ # So array(*locale) can make parameter nothing.
118
+ # ex. foo.val_name
119
+ #
120
+ define_method "#{name}_name" do |*locale|
121
+ column_name = name
122
+ column_name = opts[:column_name] if opts[:column_name]
123
+
124
+ return "" unless __send__(column_name) #reject nil in column
125
+
126
+ if opts[:number]
127
+ return "" if __send__(column_name).to_i - 1 < 0
128
+ value = values[__send__(column_name).to_i - 1]
129
+ else
130
+ value = __send__(column_name)
131
+ end
132
+
133
+ return value if opts[:i18n] == false
134
+
135
+ l = :en
136
+ l = I18n.locale if defined?(I18n.locale)
137
+ l = locale[0] if locale
138
+
139
+ i18n_scope = "activerecord"
140
+ i18n_scope = self.i18n_scope.to_s if defined?(self.i18n_scope) #rails2 support i18n_scope
141
+ I18n.t("#{i18n_scope}.attributes.#{self.model_name.to_s.underscore}.#{pluralized}.#{value}",:locale=>l)
142
+
143
+ end
144
+
145
+ # I want to use for checkbox type ,but indeed its hard to manage to store&read with Mysql
146
+ # so,it'll be dupricated in near future.
147
+ #
148
+ # foo.val_names
149
+ #
150
+ # :assumption data is array
151
+ # ex @aaa.test_names => ['a','b','c']
152
+ #
153
+ #define_method "#{name}_names" do
154
+ #array =[]
155
+ #return false if self.send(name).blank?
156
+ #if self.class.to_s.index("::")
157
+ #self.send(name).map{|n|array << I18n.t("models.#{self.class.superclass.to_s.underscore}.#{pluralized}.#{n}")}
158
+ #else
159
+ #self.send(name).map{|n|array << I18n.t("models.#{self.class.to_s.underscore}.#{pluralized}.#{n}")}
160
+ #end
161
+ #return array.join("<br />")
162
+ #end
163
+
164
+ end
165
+ end
166
+
167
+ end
168
+
@@ -0,0 +1,7 @@
1
+ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
2
+
3
+ describe "EnumAttribute" do
4
+ it "fails" do
5
+ fail "hey buddy, you should probably rename this file and start specing for real"
6
+ end
7
+ end
@@ -0,0 +1,12 @@
1
+ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
2
+ $LOAD_PATH.unshift(File.dirname(__FILE__))
3
+ require 'rspec'
4
+ require 'enum_attribute'
5
+
6
+ # Requires supporting files with custom matchers and macros, etc,
7
+ # in ./support/ and its subdirectories.
8
+ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
9
+
10
+ RSpec.configure do |config|
11
+
12
+ end
metadata ADDED
@@ -0,0 +1,124 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: enum_attribute
3
+ version: !ruby/object:Gem::Version
4
+ prerelease:
5
+ version: 0.0.1
6
+ platform: ruby
7
+ authors:
8
+ - Eiji Kosaki
9
+ autorequire:
10
+ bindir: bin
11
+ cert_chain: []
12
+
13
+ date: 2011-07-16 00:00:00 Z
14
+ dependencies:
15
+ - !ruby/object:Gem::Dependency
16
+ name: rspec
17
+ requirement: &id001 !ruby/object:Gem::Requirement
18
+ none: false
19
+ requirements:
20
+ - - ~>
21
+ - !ruby/object:Gem::Version
22
+ version: 2.3.0
23
+ type: :development
24
+ prerelease: false
25
+ version_requirements: *id001
26
+ - !ruby/object:Gem::Dependency
27
+ name: yard
28
+ requirement: &id002 !ruby/object:Gem::Requirement
29
+ none: false
30
+ requirements:
31
+ - - ~>
32
+ - !ruby/object:Gem::Version
33
+ version: 0.6.0
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: *id002
37
+ - !ruby/object:Gem::Dependency
38
+ name: bundler
39
+ requirement: &id003 !ruby/object:Gem::Requirement
40
+ none: false
41
+ requirements:
42
+ - - ~>
43
+ - !ruby/object:Gem::Version
44
+ version: 1.0.0
45
+ type: :development
46
+ prerelease: false
47
+ version_requirements: *id003
48
+ - !ruby/object:Gem::Dependency
49
+ name: jeweler
50
+ requirement: &id004 !ruby/object:Gem::Requirement
51
+ none: false
52
+ requirements:
53
+ - - ~>
54
+ - !ruby/object:Gem::Version
55
+ version: 1.6.4
56
+ type: :development
57
+ prerelease: false
58
+ version_requirements: *id004
59
+ - !ruby/object:Gem::Dependency
60
+ name: rcov
61
+ requirement: &id005 !ruby/object:Gem::Requirement
62
+ none: false
63
+ requirements:
64
+ - - ">="
65
+ - !ruby/object:Gem::Version
66
+ version: "0"
67
+ type: :development
68
+ prerelease: false
69
+ version_requirements: *id005
70
+ description: I'm going to describe detail later...
71
+ email: monkeytohuman@gmail.com
72
+ executables: []
73
+
74
+ extensions: []
75
+
76
+ extra_rdoc_files:
77
+ - LICENSE.txt
78
+ - README.md
79
+ files:
80
+ - .document
81
+ - .rspec
82
+ - .rvmrc
83
+ - Gemfile
84
+ - Gemfile.lock
85
+ - LICENSE.txt
86
+ - README.md
87
+ - Rakefile
88
+ - VERSION
89
+ - enum_attribute.gemspec
90
+ - lib/enum_attribute.rb
91
+ - spec/enum_attribute_spec.rb
92
+ - spec/spec_helper.rb
93
+ homepage: http://github.com/eijik/enum_attribute
94
+ licenses:
95
+ - MIT
96
+ post_install_message:
97
+ rdoc_options: []
98
+
99
+ require_paths:
100
+ - lib
101
+ required_ruby_version: !ruby/object:Gem::Requirement
102
+ none: false
103
+ requirements:
104
+ - - ">="
105
+ - !ruby/object:Gem::Version
106
+ hash: 2777831526094708268
107
+ segments:
108
+ - 0
109
+ version: "0"
110
+ required_rubygems_version: !ruby/object:Gem::Requirement
111
+ none: false
112
+ requirements:
113
+ - - ">="
114
+ - !ruby/object:Gem::Version
115
+ version: "0"
116
+ requirements: []
117
+
118
+ rubyforge_project:
119
+ rubygems_version: 1.8.2
120
+ signing_key:
121
+ specification_version: 3
122
+ summary: Add helper selection method for model class
123
+ test_files: []
124
+