taylors_enum 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22eddc0a8e5096da1be305ffcaf244c99e9cd53f502acf7d5d3827d64ceb5781
-  data.tar.gz: 9dcbda215ceb54dc6aef75950ad45dfa8da07e20c88ac456f1aac22804f0c5e6
+  metadata.gz: b9bf0b48903cac0265a19a6a4481b7bdb7b83fb84d75c5e2aba516854ffb9641
+  data.tar.gz: 9484a8aaebc4dd57bb98bbaad251ce98acad9b3890e2d6a442e6df973b29531c
 SHA512:
-  metadata.gz: 7c8cd3171a1e074a18550b8055ba93cb008f636ac9d350dddbe7387a9e4d5848fc00565aeff7fb6a9382fffa3afa555e7f1e27033de0ebc53cbb525677390a7f
-  data.tar.gz: d672df8ce78450646179c625f27e596a74e9118f64140db5addf70b6c1d933049a3d368a143742222c9f5b15e8b7a5d076582b09a8c64de286e06de35701f4c5
+  metadata.gz: 3973e6ebeb788496ef8dcd6f66830cc92c40c8eda2e5c815da1b19d54d03c54ca83a68ec5bc13cf34dc0a4d8ae3f260d19cfd7e6e73a236f22accde757570de9
+  data.tar.gz: 4180f8d0860eb50afd1c3f04965d537789a42fd3c348a0a506806c8ebb6f39aec594d51faf89a37f8b0b75a396450d9cd01135a32bd630aaebc48f64f6f84aef

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at peter.wdj@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/README.md

@@ -1,6 +1,6 @@
-# TaylorsEnum
+# taylors_enum
 
-TaylorsEnum is a gem that builds on top of ActiveRecord's built in [enums](https://api.rubyonrails.org/v5.2.4.4/classes/ActiveRecord/Enum.html#method-i-enum). Specifically, it will:
+taylors_enum is a gem that builds on top of ActiveRecord's built in [enums](https://api.rubyonrails.org/v5.2.4.4/classes/ActiveRecord/Enum.html#method-i-enum). Specifically, it will:
 
 ###### - Define additional methods to make it clearer which values exist in Rails-land, and which in the database
 In Rails:
@@ -14,7 +14,7 @@ end
 => {"debut"=>0, "fearless"=>1, "speak_now"=>2, "red"=>3, "nineteen_eighty_nine"=>4, "reputation"=>5, "lover"=>6, "folklore"=>7, "evermore"=>8}
 ```
 
-With TaylorsEnum:
+With taylors_enum:
 ```
 class AlbumBase < Album
   taylors_enum name: %w[debut fearless speak_now red nineteen_eighty_nine reputation lover folklore evermore]
@@ -94,7 +94,7 @@ end
 ```
 
 ###### - Enables support for all the enum goodness when enumerating classes for Polymorphic Associations
-Note: this excludes the `<attribute>!` method to update a value, as, as I write this, I can't conceive of a scenario in which you'd want to update just the type, and not also the ID, of an associated object. If you want to do this, you can still do this manually via the `ActiveRecord#update` method.
+Note: this excludes the `<attribute>!` method to update a value, as, as I write this, I can't conceive of a scenario in which you'd want to update just the type, and not also the ID, of an associated object. That doesn't mean you won't ever want to! And if you do, you can still do so manually via the `ActiveRecord#update` [method](https://guides.rubyonrails.org/active_record_basics.html#update).
 
 ```
 class Award < ActiveRecord::Base
@@ -128,21 +128,21 @@ end
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
+Install the gem and add to the application's Gemfile by running:
 
     $ bundle add taylors_enum
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+If bundler is not being used to manage dependencies, install the gem by running:
 
     $ gem install taylors_enum
 
 ## Usage
 
-Using taylors_enum is simple! Once the gem is installed, just add `taylors_enum <my_column>: ['array', 'of', 'values']` to any model that ultimately inherits from `ActiveRecord::Base`.
+Once the gem is installed, add `taylors_enum <my_column>: ['array', 'of', 'values'], **options` to any model that ultimately inherits from `ActiveRecord::Base`.
 
-The values that you pass will be the values that are stored in the database. taylors_enum will then generate a companion for each value that will be used to define constants, `?` methods to check if an object has the given value in the specified column, `!` methods to update the column to that value, and scopes to query for records with that value. See the top of this README for what this looks like in practice.
+The values that you pass will be the values that are stored in the database - except when passing `integer: true` (see below) in the options; in this case, pass an array of the values you expect to see in the Rails application. taylors_enum will then generate a companion for each value that will be used to define constants, `?` methods to check if an object has the given value in the specified column, `!` methods to update the column to that value, and scopes to query for records with that value. See the top of this README for what this looks like in practice.
 
-taylors_enum also takes a series of options, provided as a hash:
+taylors_enum also takes a series of options, provided as a hash following the specified values:
 - `prefix`: defaults to `nil`. If `true` is passed, the name of the column will be prepended to the start of the helper methods, scopes, and constants. If a string is passed, the given string will be prepended to the start of the helper methods, scopes, and constants.
 
 - `suffix`: defaults to `nil`. If `true` is passed, the name of the column will be appended to the end of the helper methods, scopes, and constants. If a string is passed, the given string will be appended to the end of the helper methods, scopes, and constants.
@@ -151,11 +151,23 @@ taylors_enum also takes a series of options, provided as a hash:
 
 - `validations`: defaults to `true`. If `false` is passed, validations, `nil` will be allowed as a value in the specified column.
 
-- `single_table_inheritance`: defaults to `false`. When using taylors_enum to help with columns on [Single Table Inheritance](https://api.rubyonrails.org/classes/ActiveRecord/Inheritance.html) models, pass this value as `true`, otherwise things won't work, and then you'll be sad.
+- `single_table_inheritance`: defaults to `false`. When using taylors_enum to help with columns on [Single Table Inheritance](https://api.rubyonrails.org/classes/ActiveRecord/Inheritance.html) models, pass this value as `true`, otherwise things won't work, and then you'll be sad. Note: this cannot be passed as `true` if `integer` or `polymorphic` are both specified as `true`; this will raise an OptionsConflictError when loading the application.
 
-- `polymorphic`: defaults to `false`. When using taylors_enum to help with type columns for [polymorphic associations](https://guides.rubyonrails.org/association_basics.html#polymorphic-associations), pass this value as `true`; this will ensure validations are run correctly, against database values rather than Rails values, and will also not create a `!` method to update the value of the column.
+- `polymorphic`: defaults to `false`. When using taylors_enum to help with _type column for [polymorphic associations](https://guides.rubyonrails.org/association_basics.html#polymorphic-associations), pass this value as `true`; this will ensure validations are run correctly, against database values rather than Rails values, and will also not create a `!` method to update the value of the column. Note: this cannot be passed as `true` if `single_table_inheritance` or `integer` are both specified as `true`; this will raise an OptionsConflictError when loading the application.
 
-If you want to see the base Rails value that will be used to generate the `value?` and `value!` methods, that `VALUE` constants, and the `value` scopes, you can load
+- `integer`: defaults to `false`. When using taylors_enum with an integer column rather than a string column, pass this as `true` to ensure constants, scopes, and helper methods are defined appropriately. Should this be something that can be inferred, rather than needing to be passed explicitly? Absolutely. However, at the time of writing, I can't figure out how to get access to this information at the point that this code is called (in the `ActiveSupport::LazyLoadHooks.on_load` [callback](https://api.rubyonrails.org/classes/ActiveSupport/LazyLoadHooks.html)), so this fudge allows integer columns to function as expected for now. Note: this cannot be passed as `true` if `single_table_inheritance` or `polymorphic` are both specified as `true`; this will raise an OptionsConflictError when loading the application.
+
+If you want to see the base Rails value that will be used to generate the `value?` and `value!` methods, that `VALUE` constants, and the `value` scopes, you can load up a Rails console with `rails c`, and run `MyModel.check_rails_value_for(database_value)`. For example:
+```
+class AlbumBase < Album
+  taylors_enum name: %w[debut fearless speak_now red nineteen_eighty_nine reputation lover folklore evermore]
+end
+
+[2] pry(#<TestDefault>)> AlbumBase.check_rails_value_for('folklore')
+=> 'folklore'
+[3] pry(#<TestDefault>)> AlbumBase.check_rails_value_for('folklore', column: :name, prefix: true)
+=> 'name_folklore'
+```
 
 ## Development
 

data/lib/taylors_enum/active_record/taylors_enum.rb

@@ -2,11 +2,14 @@ module TaylorsEnum
   module ActiveRecord
     module TaylorsEnum
       module ClassMethods
+        class OptionsConflictError < StandardError; end
+
         DEFAULT_OPTIONS = {
           prefix: nil, # can be true, false, or a string; if true, will use the column_name as the default value
           suffix: nil, # can be true, false, or a string; if true, will use the column_name as the default value
           constants: true, # can be true or false
           validations: true, # can be true or false; TODO: allow a hash of validations args to be passed
+          integer: false, # can be true or false; pass true if the column taylors_enum is called on is an integer value rather than a string
           single_table_inheritance: false,
           polymorphic: false,
           column: nil # this is set by the first argument passed to taylors_enum
@@ -21,11 +24,13 @@ module TaylorsEnum
             .merge(column: enum_column)
             .with_indifferent_access
 
+          maybe_raise_options_conflict_errors(options)
+
           values = format_values(raw_values, options: options)
 
           define_list_methods!(values, column: enum_column)
 
-          define_constants!(values) if options[:constants].present?
+          define_constants!(values, integer: options[:integer]) if options[:constants].present?
 
           # NOTE: when relying on the default rails enum, we validate against the rails-side values, as enum does its own custom validation; however, taylors_enum validates against the database-side values, as it relies on active_record validations
           values_to_validate = options[:single_table_inheritance] || options[:polymorphic] ? values.values : values.keys
@@ -36,7 +41,7 @@ module TaylorsEnum
           elsif options[:polymorphic]
             manually_define_polymorphic_enum_methods(values, column: enum_column)
           else
-            enum(enum_column => values) unless options[:single_table_inheritance]
+            enum(enum_column => values)
           end
         end
 
@@ -53,6 +58,20 @@ module TaylorsEnum
 
         private
 
+        def maybe_raise_options_conflict_errors(options)
+          raise OptionsConflictError.new(
+            'taylors_enum cannot work for both polymorphic associations and single table inheritance on the same column'
+          ) if options[:single_table_inheritance] && options[:polymorphic]
+
+          raise OptionsConflictError.new(
+            'taylors_enum cannot work for integer columns with single table inheritance'
+          ) if options[:integer] && options[:single_table_inheritance]
+
+          raise OptionsConflictError.new(
+            'taylors_enum cannot work for integer columns with polymorphic associations'
+          ) if options[:integer] && options[:polymorphic]
+        end
+
         def manually_define_single_table_inheritance_enum_methods(values, column:)
           values.each do |rails_value, database_value|
             define_boolean_method(rails_value, database_value, column)
@@ -109,9 +128,9 @@ module TaylorsEnum
           end
         end
 
-        def define_constants!(values)
+        def define_constants!(values, integer:)
           values.each do |rails_value, database_value|
-            const_set(rails_value.upcase, database_value)
+            const_set(rails_value.upcase, integer ? rails_value : database_value)
           end
         end
 
@@ -123,8 +142,9 @@ module TaylorsEnum
           prefix = generate_prefix_name(options[:prefix], column: options[:column])
           suffix = generate_suffix_name(options[:suffix], column: options[:column])
 
-          values.map do |value|
+          values.map.with_index do |value, index|
             formatted_value = value.to_s.demodulize.underscore
+            value = index if options[:integer]
             [
               "#{prefix}#{formatted_value}#{suffix}",
               value

data/lib/taylors_enum/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TaylorsEnum
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/taylors_enum.rb

@@ -3,7 +3,6 @@
 require_relative 'taylors_enum/version'
 
 module TaylorsEnum
-  class Error < StandardError; end
   require 'active_support'
   require 'active_support/core_ext/hash'
   require 'taylors_enum/active_record/active_record'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: taylors_enum
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Cassie Johnstone
@@ -90,6 +90,7 @@ extra_rdoc_files: []
 files:
 - ".rubocop.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt