str_enum 0.1.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c7a007594ea44a4ff3d3793df4cb9bdb3340bbde
-  data.tar.gz: 839f233f5aeb3abd9ed3662063803b59f29783be
+SHA256:
+  metadata.gz: 620b3321fd0fa64430af924b39bb0f07bfb3564868e7b56e5667b3df94f895f3
+  data.tar.gz: 5bf7bb0b10750e5134fef78fc9176f222f0d2d98abfabff2c6d969400fa589cb
 SHA512:
-  metadata.gz: 131fc82a1bdf5f70d7611321c5b2c93d3ca2ab4d3274f9f16e37a58de98ea86d66048ab14c52b2d5cd4fa2dcc4b24c83eb613b96217c24bbc562c275c4f308db
-  data.tar.gz: f1c2a90d1fe6bf60e321a6c0c7b7449427ef42797ee791403c52e7d6846e61ce6dc4dcd8c1cd594321b9c0724083ebbd7134e8626576aef263a807347f8cc050
+  metadata.gz: e9ced975c17b9bec4077dbdd7a0efc52bcf939c3579533656065001c98c77d374efcf22f330c891fd37f1df18c71e4f0fea987a09cfea8843d7401584ad6be94
+  data.tar.gz: 22de16567abcd58b9e8e5eb5e0e60fe5e68879e4c687c0bb574d3c0d925296118bacee4d00265368b81306984e8620f57ff3da639297be8921057195a454f904

data/CHANGELOG.md

@@ -1,19 +1,37 @@
-## 0.1.4
+## 0.3.0 (2022-01-10)
+
+- Dropped support for Ruby < 2.6 and Active Record < 5.2
+
+## 0.2.0 (2019-10-28)
+
+- Added negative scopes
+- Moved presence validation message before inclusion message
+
+## 0.1.6 (2019-07-15)
+
+- Added update methods
+
+## 0.1.5 (2016-12-12)
+
+- Added `default` option
+- Added ability to include manually
+
+## 0.1.4 (2016-10-28)
 
 - Fixed error with `select`
 
-## 0.1.3
+## 0.1.3 (2016-10-24)
 
 - Added `suffix` option
 
-## 0.1.2
+## 0.1.2 (2016-10-24)
 
 - Added method to list values
 
-## 0.1.1
+## 0.1.1 (2016-10-23)
 
 - Added `prefix` option
 
-## 0.1.0
+## 0.1.0 (2016-10-23)
 
 - First release

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2016 Andrew Kane
+Copyright (c) 2016-2022 Andrew Kane
 
 MIT License
 

data/README.md

@@ -7,13 +7,16 @@ String enums for Rails!! :tada:
 - scopes
 - validations
 - accessor methods
+- update methods
+
+[![Build Status](https://github.com/ankane/str_enum/workflows/build/badge.svg?branch=master)](https://github.com/ankane/str_enum/actions)
 
 ## Getting Started
 
 Add this line to your application’s Gemfile:
 
 ```ruby
-gem 'str_enum'
+gem "str_enum"
 ```
 
 Add a string column to your model.
@@ -39,6 +42,13 @@ User.active
 User.archived
 ```
 
+And negative scopes
+
+```ruby
+User.not_active
+User.not_archived
+```
+
 #### Validations
 
 ```ruby
@@ -53,6 +63,13 @@ user.active?
 user.archived?
 ```
 
+#### Update Methods
+
+```ruby
+user.active!
+user.archived!
+```
+
 #### Forms
 
 ```erb
@@ -65,7 +82,12 @@ Choose which features you want with:
 
 ```ruby
 class User < ActiveRecord::Base
-  str_enum :status, [:active, :archived], scopes: false, validate: false, accessor_methods: false
+  str_enum :status, [:active, :archived],
+    scopes: false,
+    validate: false,
+    accessor_methods: false,
+    update_methods: false,
+    default: nil
 end
 ```
 
@@ -83,6 +105,10 @@ User.archived_address
 # accessor methods
 user.active_address?
 user.archived_address?
+
+# update methods
+user.active_address!
+user.archived_address!
 ```
 
 ## History
@@ -97,3 +123,12 @@ Everyone is encouraged to help improve this project. Here are a few ways you can
 - Fix bugs and [submit pull requests](https://github.com/ankane/str_enum/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new features
+
+To get started with development and testing:
+
+```sh
+git clone https://github.com/ankane/str_enum.git
+cd str_enum
+bundle install
+bundle exec rake test
+```

data/lib/str_enum/model.rb

@@ -0,0 +1,49 @@
+require "active_support/concern"
+
+module StrEnum
+  module Model
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def str_enum(column, values, validate: true, scopes: true, accessor_methods: true, update_methods: true, prefix: false, suffix: false, default: true, allow_nil: false)
+        values = values.map(&:to_s)
+        if validate
+          validate_options = {}
+          if allow_nil
+            validate_options[:allow_nil] = true
+          else
+            validate_options[:presence] = true
+          end
+          validate_options[:inclusion] = {in: values}
+          validates column, validate_options
+        end
+        values.each do |value|
+          prefix = column if prefix == true
+          suffix = column if suffix == true
+          method_name = [prefix, value, suffix].select { |v| v }.join("_")
+          if scopes
+            scope method_name, -> { where(column => value) } unless respond_to?(method_name)
+            scope "not_#{method_name}", -> { where.not(column => value) } unless respond_to?("not_#{method_name}")
+          end
+          if accessor_methods && !method_defined?("#{method_name}?")
+            define_method "#{method_name}?" do
+              read_attribute(column) == value
+            end
+          end
+          if update_methods && !method_defined?("#{method_name}!")
+            define_method "#{method_name}!" do
+              update!(column => value)
+            end
+          end
+        end
+        default_value = default == true ? values.first : default
+        after_initialize do
+          send("#{column}=", default_value) unless try(column)
+        end
+        define_singleton_method column.to_s.pluralize do
+          values
+        end
+      end
+    end
+  end
+end

data/lib/str_enum/version.rb

@@ -1,3 +1,3 @@
 module StrEnum
-  VERSION = "0.1.4"
+  VERSION = "0.3.0"
 end

data/lib/str_enum.rb

@@ -1,30 +1,10 @@
-require "str_enum/version"
+# dependencies
 require "active_support"
 
-module StrEnum
-  def str_enum(column, values, validate: true, scopes: true, accessor_methods: true, prefix: false, suffix: false)
-    values = values.map(&:to_s)
-    validates column, presence: true, inclusion: {in: values} if validate
-    values.each do |value|
-      prefix = column if prefix == true
-      suffix = column if suffix == true
-      method_name = [prefix, value, suffix].select { |v| v }.join("_")
-      scope method_name, -> { where(column => value) } if scopes && !respond_to?(method_name)
-      if accessor_methods && !method_defined?("#{method_name}?")
-        define_method "#{method_name}?" do
-          read_attribute(column) == value
-        end
-      end
-    end
-    after_initialize do
-      send("#{column}=", values.first) unless try(column)
-    end
-    define_singleton_method column.to_s.pluralize do
-      values
-    end
-  end
-end
+# modules
+require "str_enum/model"
+require "str_enum/version"
 
 ActiveSupport.on_load(:active_record) do
-  extend(StrEnum)
+  include StrEnum::Model
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: str_enum
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
-bindir: exe
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2016-10-29 00:00:00.000000000 Z
+date: 2022-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,76 +16,31 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  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: rake
-  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: minitest
-  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: 
-email:
-- andrew@chartkick.com
+        version: '5.2'
+description:
+email: andrew@ankane.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - lib/str_enum.rb
+- lib/str_enum/model.rb
 - lib/str_enum/version.rb
-- str_enum.gemspec
 homepage: https://github.com/ankane/str_enum
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -93,16 +48,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: String enums for Rails
 test_files: []

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/Gemfile

@@ -1,7 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in str_enum.gemspec
-gemspec
-
-gem "activerecord", "~> 5.0.0"
-gem "sqlite3"

data/Rakefile

@@ -1,10 +0,0 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
-
-task default: :test

data/str_enum.gemspec

@@ -1,25 +0,0 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "str_enum/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "str_enum"
-  spec.version       = StrEnum::VERSION
-  spec.authors       = ["Andrew Kane"]
-  spec.email         = ["andrew@chartkick.com"]
-
-  spec.summary       = "String enums for Rails"
-  spec.homepage      = "https://github.com/ankane/str_enum"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "activesupport"
-
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest"
-end