enumbler 0.6.14 → 0.9.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 66bbc4c564df073b9bc20f03c8910c4f20c41d807c263f07184ad858e9cb96eb
4
- data.tar.gz: cedfcee8d80c6a453c8ddea9954c40405da2558d3be9e603fc0d5f6d8bf42986
3
+ metadata.gz: af754378eb4d6913b7d2f6521ae88e1cc59ceb3b8d76211e1cad637bc154634f
4
+ data.tar.gz: 19fcc7da7e52d35a079e9fbb4da6781d84df7b704fe1482a69ec553edf2dd709
5
5
  SHA512:
6
- metadata.gz: e3ed4b05cd073b3586922f4836e7529ae8f9360c8bf5231d4ba436abe176c788577db93215af9ef9d675da48ae15ffe796db81cdefb3c55f1d8f8ae741f4390d
7
- data.tar.gz: dba88529dafd834bf7c5dbd522b52fadb6ab18b975493e091ba349c1a10dee5652dac21ad5b70e50f231e6620bca909768a0fa3219eb105a59ebafc75389d30d
6
+ metadata.gz: db53c9304123815cbda6900f3855b33b6fe7100233bd8b0eb7dea3223fea32b57760fe0ea0adfe02b4f5cda86dea0bb8ce327873117369577045f7502ba4af07
7
+ data.tar.gz: cdc6f3e944d5b1e92b2a6f41f118ef6d4685bb4bf78ce01c267f9549b9a009daf9b9d3edacd9111acfac96b4f1a2571181e29207684f9e197fd4f12d9afc8e76
data/.gitignore CHANGED
@@ -9,5 +9,6 @@
9
9
 
10
10
  # rspec failure tracking
11
11
  .rspec_status
12
+ .byebug_history
12
13
 
13
14
  tags*
@@ -1,7 +1,6 @@
1
1
  AllCops:
2
- TargetRubyVersion: 2.6
3
- Exclude:
4
- - 'bin/pre_commit_rubocop.rb'
2
+ NewCops: enable
3
+ TargetRubyVersion: 2.5
5
4
 
6
5
  Layout/ArgumentAlignment:
7
6
  Enabled: true
@@ -11,16 +10,36 @@ Layout/FirstHashElementIndentation:
11
10
  Enabled: true
12
11
  EnforcedStyle: consistent
13
12
 
13
+ Layout/HashAlignment:
14
+ Enabled: true
15
+ # This allows "implicit" hash arguments (without curly braces) to be aligned
16
+ # differently.
17
+ EnforcedLastArgumentHashStyle: ignore_implicit
18
+
14
19
  Layout/LineLength:
15
20
  AllowURI: true
16
21
  Max: 119
17
22
 
23
+ Layout/MultilineMethodCallIndentation:
24
+ Enabled: true
25
+ EnforcedStyle: indented
26
+
18
27
  Lint/RaiseException:
19
28
  Enabled: true
20
29
 
21
30
  Lint/StructNewOverride:
22
31
  Enabled: true
23
32
 
33
+ Metrics:
34
+ Enabled: false
35
+
36
+ Naming/MethodParameterName:
37
+ Enabled: true
38
+ AllowedNames: [at, by, db, id, in, ip, of, on, to, tz]
39
+
40
+ Naming/PredicateName:
41
+ Enabled: true
42
+
24
43
  Style/Documentation:
25
44
  Enabled: false
26
45
 
@@ -33,6 +52,9 @@ Style/HashTransformKeys:
33
52
  Style/HashTransformValues:
34
53
  Enabled: true
35
54
 
55
+ Style/StringLiterals:
56
+ EnforcedStyle: double_quotes
57
+
36
58
  Style/TrailingCommaInHashLiteral:
37
59
  Enabled: true
38
60
  EnforcedStyleForMultiline: consistent_comma
@@ -41,5 +63,5 @@ Style/TrailingCommaInArrayLiteral:
41
63
  Enabled: true
42
64
  EnforcedStyleForMultiline: consistent_comma
43
65
 
44
- Metrics:
45
- Enabled: false
66
+ Style/TrailingCommaInArguments:
67
+ EnforcedStyleForMultiline: consistent_comma
data/Gemfile CHANGED
@@ -1,6 +1,6 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- source 'https://rubygems.org'
3
+ source "https://rubygems.org"
4
4
 
5
5
  # Specify your gem's dependencies in enumbler.gemspec
6
6
  gemspec
@@ -1,9 +1,9 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- enumbler (0.6.14)
5
- activerecord (>= 5.2.3, < 6.1)
6
- activesupport (>= 5.2.3, < 6.1)
4
+ enumbler (0.9.0)
5
+ activerecord (>= 5.2.3, < 7)
6
+ activesupport (>= 5.2.3, < 7)
7
7
 
8
8
  GEM
9
9
  remote: https://rubygems.org/
@@ -19,7 +19,8 @@ GEM
19
19
  minitest (~> 5.1)
20
20
  tzinfo (~> 1.1)
21
21
  zeitwerk (~> 2.2, >= 2.2.2)
22
- ast (2.4.0)
22
+ ast (2.4.1)
23
+ coderay (1.1.2)
23
24
  concurrent-ruby (1.1.6)
24
25
  database_cleaner (1.8.5)
25
26
  database_cleaner-active_record (1.8.0)
@@ -31,13 +32,17 @@ GEM
31
32
  ruby-progressbar (~> 1.4)
32
33
  i18n (1.8.2)
33
34
  concurrent-ruby (~> 1.0)
34
- jaro_winkler (1.5.4)
35
+ method_source (1.0.0)
35
36
  minitest (5.14.1)
36
37
  parallel (1.19.1)
37
- parser (2.7.1.3)
38
- ast (~> 2.4.0)
38
+ parser (2.7.1.4)
39
+ ast (~> 2.4.1)
40
+ pry (0.13.1)
41
+ coderay (~> 1.1)
42
+ method_source (~> 1.0)
39
43
  rainbow (3.0.0)
40
44
  rake (12.3.3)
45
+ regexp_parser (1.7.1)
41
46
  rexml (3.2.4)
42
47
  rspec (3.9.0)
43
48
  rspec-core (~> 3.9.0)
@@ -52,14 +57,17 @@ GEM
52
57
  diff-lcs (>= 1.2.0, < 2.0)
53
58
  rspec-support (~> 3.9.0)
54
59
  rspec-support (3.9.3)
55
- rubocop (0.81.0)
56
- jaro_winkler (~> 1.5.1)
60
+ rubocop (0.91.0)
57
61
  parallel (~> 1.10)
58
- parser (>= 2.7.0.1)
62
+ parser (>= 2.7.1.1)
59
63
  rainbow (>= 2.2.2, < 4.0)
64
+ regexp_parser (>= 1.7)
60
65
  rexml
66
+ rubocop-ast (>= 0.4.0, < 1.0)
61
67
  ruby-progressbar (~> 1.7)
62
68
  unicode-display_width (>= 1.4.0, < 2.0)
69
+ rubocop-ast (0.4.0)
70
+ parser (>= 2.7.1.4)
63
71
  ruby-progressbar (1.10.1)
64
72
  sqlite3 (1.4.2)
65
73
  thread_safe (0.3.6)
@@ -75,9 +83,10 @@ DEPENDENCIES
75
83
  database_cleaner-active_record (~> 1.8.0)
76
84
  enumbler!
77
85
  fuubar (~> 2.5)
86
+ pry
78
87
  rake (~> 12.0)
79
88
  rspec (~> 3.9.0)
80
- rubocop (~> 0.81.0)
89
+ rubocop (~> 0.91.0)
81
90
  sqlite3 (~> 1.4.0)
82
91
 
83
92
  BUNDLED WITH
data/README.md CHANGED
@@ -91,6 +91,17 @@ Color.ids_from_enumbler(:black, 'does-no-exist') # => [1, nil]
91
91
  Color.ids_from_enumbler!(:black, 'does-no-exist') # => raises Enumbler::Error
92
92
  Color.id_from_enumbler!(:does_not_exist) # => raises Enumbler::Error
93
93
 
94
+ # Get a model instance (like `.find_by` in Rails)
95
+ Color.find_by_enumble(1)
96
+ Color.find_by_enumble(:black)
97
+ Color.find_by_enumble("black")
98
+ Color.find_by_enumble("BLACK")
99
+ Color.find_by_enumble(Color.black) # => self
100
+ Color.find_by_enumble("whoops") # => nil
101
+
102
+ # Raise ActiveRecord::RecordNotFound error with bang
103
+ Color.find_by_enumble!("whoops") # => nil
104
+
94
105
  # Get enumble object by id
95
106
  house = House.create!(color: Color.black)
96
107
 
@@ -108,12 +119,14 @@ House.color(Color.black, :white) # => ActiveRecord::Relation<house, house2>
108
119
 
109
120
  ### Use a column other than `label`
110
121
 
111
- By default, the Enumbler expects a table in the database with a column `label`. However, you can change this to another underlying column name. Note that the enumbler still treats it as a `label` column; however it will be saved to the correct place in the database.
122
+ By default, the Enumbler expects a table in the database with a column `label`. However, you can change this to another underlying column name. Note that the enumbler still treats it as a `label` column; however it will be saved to the correct place in the database. Your model now can have its own `label` separate from whatever attribute/column was
123
+ specified for Enumbler usage.
112
124
 
113
125
  ```ruby
114
126
  ActiveRecord::Schema.define do
115
127
  create_table :feelings, force: true do |t|
116
128
  t.string :emotion, null: false, index: { unique: true }
129
+ t.string :label
117
130
  end
118
131
  end
119
132
 
@@ -125,8 +138,15 @@ class Feeling < ApplicationRecord
125
138
 
126
139
  enumble :sad, 1
127
140
  enumble :happy, 2
128
- enumble :verklempt, 3, label: 'overcome with emotion'
141
+ enumble :verklempt, 3, label: "Verklempt!", emotion: 'overcome with emotion'
129
142
  end
143
+
144
+ # Now the `Feeling` model can use `label` if it wants to
145
+ # and not conflict with Enumbler usage (:emotion in this case)
146
+ # .enumble.label & .emotion is used internally by Enumbler
147
+ Feeling.verklempt.label # => 'Verklempt!'
148
+ Feeling.verklempt.enumble.label # => 'overcome with emotion'
149
+ Feeling.verklempt.emotion # => 'overcome with emotion'
130
150
  ```
131
151
 
132
152
  ## Core ext
@@ -140,6 +160,7 @@ when :black
140
160
  when :blue, :purple
141
161
  'very surprised'
142
162
  end
163
+ ```
143
164
 
144
165
  ## Development
145
166
 
@@ -149,14 +170,12 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
149
170
 
150
171
  ## Roadmap
151
172
 
152
- * We need to add in support for additional attributes/columns in the enumbled table. For example, following the `Color` concept, we may want to have a column which is `hex` and stores the colors `hex` value (e.g., `FFFFFF`). This should be supported.
153
- * Ideally, we could make this work more like a traditional `enum`; for example, overriding the `.where` method by allowing something like: `House.where(color: :blue)` instead of `House.where_color(:blue)`. But right now am in a rush and not sure how to go about doing that properly.
173
+ * Ideally, we could make this work more like a traditional `enum`; for example, overriding the `.where` method by allowing something like: `House.where(color: :blue)` instead of `House.color(:blue)`. But right now am in a rush and not sure how to go about doing that properly.
154
174
 
155
175
  ## Contributing
156
176
 
157
177
  Bug reports and pull requests are welcome on GitHub at https://github.com/linguabee/enumbler.
158
178
 
159
-
160
179
  ## License
161
180
 
162
181
  The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
data/Rakefile CHANGED
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'bundler/gem_tasks'
4
- require 'rspec/core/rake_task'
3
+ require "bundler/gem_tasks"
4
+ require "rspec/core/rake_task"
5
5
 
6
6
  RSpec::Core::RakeTask.new(:spec)
7
7
 
@@ -1,8 +1,8 @@
1
1
  #!/usr/bin/env ruby
2
2
  # frozen_string_literal: true
3
3
 
4
- require 'bundler/setup'
5
- require 'enumbler'
4
+ require "bundler/setup"
5
+ require "enumbler"
6
6
 
7
7
  # You can add fixtures and/or initialization code here to make experimenting
8
8
  # with your gem easier. You can also use a different console, if you like.
@@ -11,5 +11,5 @@ require 'enumbler'
11
11
  # require "pry"
12
12
  # Pry.start
13
13
 
14
- require 'irb'
14
+ require "irb"
15
15
  IRB.start(__FILE__)
@@ -1,8 +1,10 @@
1
1
  #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
2
4
  # Put this file into your path and use `<file> install` to add a new hook
3
5
  # or use it as a binary to check changed files
4
6
 
5
- require 'shellwords'
7
+ require "shellwords"
6
8
 
7
9
  if ARGV == ["install"]
8
10
  exec "ln", "-sf", File.expand_path(File.basename(__FILE__), __dir__), ".git/hooks/pre-commit"
@@ -10,15 +12,23 @@ else
10
12
  raise unless ARGV == []
11
13
  end
12
14
 
13
- changed = `git status --porcelain`.
14
- split("\n").
15
- map { |l| l.split(" ", 2) }.
16
- select { |status, _| ["A", "AM", "M"].include?(status) }.
17
- map { |_, file| file.delete('"') }
15
+ changed = `git status --porcelain`
16
+ .split("\n")
17
+ .map { |l| l.split(" ", 2) }
18
+ .select { |status, _| %w[A AM M].include?(status) }
19
+ .map { |_, file| file.delete('"') }
18
20
 
19
21
  exit if changed.empty?
20
22
 
21
- parallel = ((File.read(".rubocop.yml").include?("UseCache: false") rescue false) ? "" : " --parallel")
23
+ parallel = (if begin
24
+ File.read(".rubocop.yml").include?("UseCache: false")
25
+ rescue StandardError
26
+ false
27
+ end
28
+ ""
29
+ else
30
+ " --parallel"
31
+ end)
22
32
  result = `bundle exec rubocop #{parallel} --color --force-exclusion #{changed.shelljoin}`
23
- puts result unless $?.success?
24
- exit $?.exitstatus
33
+ puts result unless $CHILD_STATUS.success?
34
+ exit $CHILD_STATUS.exitstatus
@@ -1,41 +1,42 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require_relative 'lib/enumbler/version'
3
+ require_relative "lib/enumbler/version"
4
4
 
5
5
  Gem::Specification.new do |spec|
6
- spec.name = 'enumbler'
6
+ spec.name = "enumbler"
7
7
  spec.version = Enumbler::VERSION
8
- spec.authors = ['Damon Timm']
9
- spec.email = ['damon@linguabee.com']
8
+ spec.authors = ["Damon Timm"]
9
+ spec.email = ["damon@linguabee.com"]
10
10
 
11
11
  spec.summary = "Enums are terrific, but lack integrity. Let's add some!"
12
- spec.description = 'A more complete description is forthcoming.'
13
- spec.homepage = 'https://github.com/linguabee/enumbler'
14
- spec.license = 'MIT'
15
- spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
12
+ spec.description = "A more complete description is forthcoming."
13
+ spec.homepage = "https://github.com/linguabee/enumbler"
14
+ spec.license = "MIT"
15
+ spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
16
16
 
17
- spec.metadata['allowed_push_host'] = 'https://rubygems.org'
17
+ spec.metadata["allowed_push_host"] = "https://rubygems.org"
18
18
 
19
- spec.metadata['homepage_uri'] = spec.homepage
20
- spec.metadata['source_code_uri'] = spec.homepage
21
- spec.metadata['changelog_uri'] = spec.homepage
19
+ spec.metadata["homepage_uri"] = spec.homepage
20
+ spec.metadata["source_code_uri"] = spec.homepage
21
+ spec.metadata["changelog_uri"] = spec.homepage
22
22
 
23
23
  # Specify which files should be added to the gem when it is released.
24
24
  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
25
25
  spec.files = Dir.chdir(File.expand_path(__dir__)) do
26
26
  `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
27
27
  end
28
- spec.bindir = 'exe'
28
+ spec.bindir = "exe"
29
29
  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
30
- spec.require_paths = ['lib']
31
-
32
- spec.add_dependency 'activerecord', ['>= 5.2.3', '< 6.1']
33
- spec.add_dependency 'activesupport', ['>= 5.2.3', '< 6.1']
34
-
35
- spec.add_development_dependency 'database_cleaner-active_record', '~> 1.8.0'
36
- spec.add_development_dependency 'fuubar', '~> 2.5'
37
- spec.add_development_dependency 'rake', '~> 12.0'
38
- spec.add_development_dependency 'rspec', '~> 3.9.0'
39
- spec.add_development_dependency 'rubocop', '~> 0.81.0'
40
- spec.add_development_dependency 'sqlite3', '~> 1.4.0'
30
+ spec.require_paths = ["lib"]
31
+
32
+ spec.add_dependency "activerecord", [">= 5.2.3", "< 7"]
33
+ spec.add_dependency "activesupport", [">= 5.2.3", "< 7"]
34
+
35
+ spec.add_development_dependency "database_cleaner-active_record", "~> 1.8.0"
36
+ spec.add_development_dependency "fuubar", "~> 2.5"
37
+ spec.add_development_dependency "pry"
38
+ spec.add_development_dependency "rake", "~> 12.0"
39
+ spec.add_development_dependency "rspec", "~> 3.9.0"
40
+ spec.add_development_dependency "rubocop", "~> 0.91.0"
41
+ spec.add_development_dependency "sqlite3", "~> 1.4.0"
41
42
  end
@@ -0,0 +1,12 @@
1
+ # EXAMPLE USAGE
2
+ # Refer for explanation to following link:
3
+ # https://github.com/Arkweid/lefthook/blob/master/docs/full_guide.md
4
+
5
+ pre-commit:
6
+ parallel: true
7
+ commands:
8
+ rubocop:
9
+ tags: backend style
10
+ glob: "*.rb"
11
+ exclude: "application.rb|routes.rb"
12
+ run: bundle exec rubocop --force-exclusion {all_files}
@@ -1,14 +1,14 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'enumbler/core_ext/symbol/case_equality_operator'
3
+ require "enumbler/core_ext/symbol/case_equality_operator"
4
4
 
5
- require 'enumbler/collection'
6
- require 'enumbler/enumble'
7
- require 'enumbler/enabler'
8
- require 'enumbler/version'
5
+ require "enumbler/collection"
6
+ require "enumbler/enumble"
7
+ require "enumbler/enabler"
8
+ require "enumbler/version"
9
9
 
10
- require 'active_support/concern'
11
- require 'active_support/inflector'
10
+ require "active_support/concern"
11
+ require "active_support/inflector"
12
12
 
13
13
  # The Enumbler add integrity to our enum implementation!
14
14
  module Enumbler
@@ -16,7 +16,7 @@ module Enumbler
16
16
  super
17
17
  end
18
18
 
19
- def respond_to_missing?(method_name, include_private = false)
19
+ def respond_to_missing?(method_name, *args, &block)
20
20
  enumble = find { |e| e.enum == method_name }
21
21
  enumble.present? || super
22
22
  end
@@ -12,7 +12,7 @@ module Enumbler
12
12
  def enumble
13
13
  @enumble = self.class.find_enumble(id)
14
14
 
15
- raise Error, 'An enumble is not defined for this record!' if @enumble.nil?
15
+ raise Error, "An enumble is not defined for this record!" if @enumble.nil?
16
16
 
17
17
  @enumble
18
18
  end
@@ -126,6 +126,51 @@ module Enumbler
126
126
  @enumbler_label_column_name = label_column_name
127
127
  end
128
128
 
129
+ # Like `ActiveRecord#find_by`, will try and return an instance of this
130
+ # model that matches any of our enumble attributes (instance, id, string,
131
+ # or symbol).
132
+ #
133
+ # Color.find_by_enumble(1)
134
+ # Color.find_by_enumble(:black)
135
+ # Color.find_by_enumble("black")
136
+ # Color.find_by_enumble("BLACK")
137
+ # Color.find_by_enumble(Color.black) # => self
138
+ # Color.find_by_enumble("whoops") # => nil
139
+ #
140
+ # @param arg [Class, String, Integer, Symbol] search argument
141
+ # @param case_sensitive [Boolean] string search to be case sensitive (default: false)
142
+ # @param raise_error [Boolean] whether to raise RecordNotFound error (default: false)
143
+ # @return [self]
144
+ def find_by_enumble(arg, case_sensitive: false, raise_error: false)
145
+ return arg if arg.instance_of?(@enumbled_model)
146
+
147
+ id = id_from_enumbler(arg, case_sensitive: case_sensitive, raise_error: raise_error)
148
+
149
+ find_by = raise_error ? :find_by! : :find_by
150
+ @enumbled_model.public_send(find_by, id: id)
151
+ rescue Enumbler::Error
152
+ raise ActiveRecord::RecordNotFound.new("Couldn't find #{@enumbled_model}", @enumbled_model)
153
+ end
154
+
155
+ # Like `ActiveRecord#find`, will try and return an instance of this model
156
+ # that matches any of our enumble attributes (instance, id, string, or
157
+ # symbol) raises a `RecordNotFound` error if none found.
158
+ #
159
+ # Color.find_by_enumble!(1)
160
+ # Color.find_by_enumble!(:black)
161
+ # Color.find_by_enumble!("black")
162
+ # Color.find_by_enumble!("BLACK")
163
+ # Color.find_by_enumble!(Color.black) # => returns self
164
+ # Color.find_by_enumble!("whoops") # => raise ActiveRecord::RecordNotFound
165
+ #
166
+ # @param arg [Class, String, Integer, Symbol] search argument
167
+ # @param case_sensitive [Boolean] string search to be case sensitive (default: false)
168
+ # @param raise_error [Boolean] whether to raise RecordNotFound error (default: false)
169
+ # @return [self]
170
+ def find_by_enumble!(arg, case_sensitive: false)
171
+ find_by_enumble(arg, case_sensitive: case_sensitive, raise_error: true)
172
+ end
173
+
129
174
  # See {.find_enumbles}. Simply returns the first object. Use when you
130
175
  # want one argument to be found and not returned in an array.
131
176
  # @raise [Error] when there is no [Enumbler::Enumble] to be found and
@@ -182,6 +227,8 @@ module Enumbler
182
227
  enumble =
183
228
  if arg.is_a?(Symbol)
184
229
  @enumbled_model.enumbles.find { |e| e.enum == arg }
230
+ elsif arg.is_a?(Enumbler::Enumble)
231
+ @enumbled_model.enumbles.find { |e| e.enum == arg.enum }
185
232
  elsif arg.is_a?(String)
186
233
  @enumbled_model.enumbles.find do |e|
187
234
  if case_sensitive
@@ -285,7 +332,7 @@ module Enumbler
285
332
  # longer defined (default: false)
286
333
  # @param validate [Boolean] validate on save?
287
334
  def seed_the_enumbler(delete_missing_records: false, validate: true)
288
- max_database_id = all.order('id desc').take&.id || 0
335
+ max_database_id = all.order("id desc").take&.id || 0
289
336
  max_enumble_id = @enumbles.map(&:id).max
290
337
 
291
338
  # If we are not deleting records, we just need to update each listed
@@ -330,11 +377,21 @@ module Enumbler
330
377
  method_name = "#{enumble.enum}?"
331
378
  not_method_name = "not_#{enumble.enum}?"
332
379
  alias_method_name = "is_#{enumble.enum}"
380
+ any_method_name = "any_#{enumble.enum}?"
381
+
382
+ [method_name, not_method_name, alias_method_name].each do |mname|
383
+ detect_enumbler_conflict(enumble.enum, mname)
384
+ end
385
+
386
+ [enumble.enum, any_method_name].each do |mname|
387
+ detect_enumbler_conflict(enumble.enum, mname, klass_method: true)
388
+ end
333
389
 
334
390
  const_set(enumble.enum.to_s.upcase, enumble.id)
335
391
  define_method(method_name) { id == enumble.id }
336
392
  define_method(not_method_name) { id != enumble.id }
337
393
  alias_method alias_method_name, method_name
394
+
338
395
  define_singleton_method(enumble.enum) do |attr = nil|
339
396
  return find(enumble.id) if attr.nil?
340
397
 
@@ -343,13 +400,42 @@ module Enumbler
343
400
  raise Enumbler::Error, "The attribute #{attr} is not supported on this Enumble."
344
401
  end
345
402
 
346
- define_singleton_method("any_#{enumble.enum}?") do
403
+ define_singleton_method(any_method_name) do
347
404
  where(id: enumble.id).exists?
348
405
  rescue NoMethodError
349
406
  raise Enumbler::Error, "The attribute #{attr} is not supported on this Enumble."
350
407
  end
351
408
  end
352
409
 
410
+ # This idea sourced lovingly from ActiveRecord::Enum
411
+ ENUMBLER_CONFLICT_MESSAGE = <<~TEXT.squish
412
+ You tried to define the enumble :%<enum>s on the model %<klass>s, but
413
+ this will generate a %<type>s method `%<method>s`, which is already defined
414
+ by %<source>s.
415
+ TEXT
416
+
417
+ def detect_enumbler_conflict(enumble_name, method_name, klass_method: false)
418
+ if klass_method && dangerous_class_method?(method_name)
419
+ raise_conflict_error(enumble_name, method_name, type: "class")
420
+ elsif klass_method && method_defined_within?(method_name, ActiveRecord::Relation)
421
+ raise_conflict_error(enumble_name, method_name, type: "class", source: ActiveRecord::Relation.name)
422
+ elsif !klass_method && dangerous_attribute_method?(method_name)
423
+ raise_conflict_error(enumble_name, method_name)
424
+ end
425
+ end
426
+
427
+ def raise_conflict_error(enumble_name, method_name, type: "instance", source: "ActiveRecord")
428
+ raise Error,
429
+ format(
430
+ ENUMBLER_CONFLICT_MESSAGE,
431
+ enum: enumble_name,
432
+ klass: name,
433
+ type: type,
434
+ method: method_name,
435
+ source: source,
436
+ )
437
+ end
438
+
353
439
  # I accidentally forgot to provide an id one time and it was confusing as
354
440
  # the last argument became the hash of options. This should help.
355
441
  def validate_id_is_numeric(enum, id)
@@ -370,7 +456,7 @@ module Enumbler
370
456
  "The model #{self} does not support the attribute(s): #{unsupported_attrs.keys.map(&:to_s).to_sentence}"
371
457
  rescue ActiveRecord::StatementInvalid
372
458
  warn "[Enumbler Warning] => Unable to find a table for #{self}."\
373
- 'This is to be expected if there is a pending migration; however, if there is not then something is amiss.'
459
+ "This is to be expected if there is a pending migration; however, if there is not then something is amiss."
374
460
  end
375
461
  end
376
462
  end
@@ -8,9 +8,10 @@ module Enumbler
8
8
  def initialize(enum, id, label: nil, label_column_name: :label, **attributes)
9
9
  @id = id
10
10
  @enum = enum
11
- @label = label || enum.to_s.dasherize
12
11
  @label_column_name = label_column_name
12
+ @label = (label_col_specified? ? attributes[label_column_name] : label) || enum.to_s.dasherize
13
13
  @additional_attributes = attributes || {}
14
+ @additional_attributes.merge!({ label: label }) if label_col_specified?
14
15
  end
15
16
 
16
17
  def ==(other)
@@ -19,10 +20,9 @@ module Enumbler
19
20
  end
20
21
 
21
22
  def attributes
22
- @additional_attributes.merge({
23
- id: id,
24
- label_column_name => label,
25
- })
23
+ hash = { id: id, label_column_name => label }
24
+ hash.merge!({ label: @additional_attributes[:label] }) if label_col_specified?
25
+ @additional_attributes.merge(hash)
26
26
  end
27
27
 
28
28
  # Used to return itself from a class method.
@@ -50,5 +50,11 @@ module Enumbler
50
50
  def to_s
51
51
  enum
52
52
  end
53
+
54
+ private
55
+
56
+ def label_col_specified?
57
+ label_column_name != :label
58
+ end
53
59
  end
54
60
  end
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Enumbler
4
- VERSION = '0.6.14'
4
+ VERSION = "0.9.0"
5
5
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: enumbler
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.6.14
4
+ version: 0.9.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Damon Timm
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2020-09-29 00:00:00.000000000 Z
11
+ date: 2021-01-12 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: activerecord
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: 5.2.3
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
- version: '6.1'
22
+ version: '7'
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: 5.2.3
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
- version: '6.1'
32
+ version: '7'
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: activesupport
35
35
  requirement: !ruby/object:Gem::Requirement
@@ -39,7 +39,7 @@ dependencies:
39
39
  version: 5.2.3
40
40
  - - "<"
41
41
  - !ruby/object:Gem::Version
42
- version: '6.1'
42
+ version: '7'
43
43
  type: :runtime
44
44
  prerelease: false
45
45
  version_requirements: !ruby/object:Gem::Requirement
@@ -49,7 +49,7 @@ dependencies:
49
49
  version: 5.2.3
50
50
  - - "<"
51
51
  - !ruby/object:Gem::Version
52
- version: '6.1'
52
+ version: '7'
53
53
  - !ruby/object:Gem::Dependency
54
54
  name: database_cleaner-active_record
55
55
  requirement: !ruby/object:Gem::Requirement
@@ -78,6 +78,20 @@ dependencies:
78
78
  - - "~>"
79
79
  - !ruby/object:Gem::Version
80
80
  version: '2.5'
81
+ - !ruby/object:Gem::Dependency
82
+ name: pry
83
+ requirement: !ruby/object:Gem::Requirement
84
+ requirements:
85
+ - - ">="
86
+ - !ruby/object:Gem::Version
87
+ version: '0'
88
+ type: :development
89
+ prerelease: false
90
+ version_requirements: !ruby/object:Gem::Requirement
91
+ requirements:
92
+ - - ">="
93
+ - !ruby/object:Gem::Version
94
+ version: '0'
81
95
  - !ruby/object:Gem::Dependency
82
96
  name: rake
83
97
  requirement: !ruby/object:Gem::Requirement
@@ -112,14 +126,14 @@ dependencies:
112
126
  requirements:
113
127
  - - "~>"
114
128
  - !ruby/object:Gem::Version
115
- version: 0.81.0
129
+ version: 0.91.0
116
130
  type: :development
117
131
  prerelease: false
118
132
  version_requirements: !ruby/object:Gem::Requirement
119
133
  requirements:
120
134
  - - "~>"
121
135
  - !ruby/object:Gem::Version
122
- version: 0.81.0
136
+ version: 0.91.0
123
137
  - !ruby/object:Gem::Dependency
124
138
  name: sqlite3
125
139
  requirement: !ruby/object:Gem::Requirement
@@ -155,6 +169,7 @@ files:
155
169
  - bin/pre_commit_rubocop.rb
156
170
  - bin/setup
157
171
  - enumbler.gemspec
172
+ - lefthook.yml
158
173
  - lib/enumbler.rb
159
174
  - lib/enumbler/collection.rb
160
175
  - lib/enumbler/core_ext/symbol/case_equality_operator.rb
@@ -184,7 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
184
199
  - !ruby/object:Gem::Version
185
200
  version: '0'
186
201
  requirements: []
187
- rubygems_version: 3.1.2
202
+ rubygems_version: 3.1.4
188
203
  signing_key:
189
204
  specification_version: 4
190
205
  summary: Enums are terrific, but lack integrity. Let's add some!