str_enum 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b1feedc135da7927cbe30d1b3adea0905a2c1cde
+  data.tar.gz: c07e9d2a957da6a464b60ba6c258adcbefeb445a
+SHA512:
+  metadata.gz: 35f31098800bf578473e2edb8c46cb76134e63492addd325647f948c3754b2234f994af2ac132661ea2fa16ae17c0a0ec4b5804f85ba6d40354cdeb863ac5bd2
+  data.tar.gz: 5b99e03f4dd40a034ae6d8e86e52931e6894b78d8da234c4e597e26a03ec00e78ff1c04d01bc7a5027fabb551e9b58115fe27a3a51d017cf5be1de50c7bad89a

data/.gitignore

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,67 @@
+# str_enum
+
+Don’t want to store enums as integers in your database? Introducing...
+
+String enums for Rails!! :tada:
+
+- scopes
+- validations
+- accessor methods
+
+## Getting Started
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'str_enum'
+```
+
+In your models, use:
+
+```ruby
+class User < ActiveRecord::Base
+  str_enum :status, [:active, :archived]
+end
+```
+
+The first value will be the initial value. This gives you...
+
+### Scopes
+
+```ruby
+User.active
+User.archived
+```
+
+### Validations
+
+```ruby
+user = User.new(status: "unknown")
+user.valid? # false
+```
+
+### Accessor Methods
+
+```ruby
+user.active?
+user.archived?
+```
+
+## Customize
+
+Choose which features you want
+
+```ruby
+class User < ActiveRecord::Base
+  str_enum :status, [:active, :archived], scopes: false, validate: false, accessor_methods: false
+end
+```
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/ankane/str_enum/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/str_enum/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features

data/Rakefile

@@ -0,0 +1,10 @@
+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/lib/str_enum/version.rb

@@ -0,0 +1,3 @@
+module StrEnum
+  VERSION = "0.1.0"
+end

data/lib/str_enum.rb

@@ -0,0 +1,24 @@
+require "str_enum/version"
+require "active_support"
+
+module StrEnum
+  def str_enum(column, values, validate: true, scopes: true, accessor_methods: true)
+    values = values.map(&:to_s)
+    validates column, presence: true, inclusion: {in: values} if validate
+    values.each do |value|
+      scope value, -> { where(column => value) } if scopes && !respond_to?(value)
+      if accessor_methods && !method_defined?("#{value}?")
+        define_method "#{value}?" do
+          read_attribute(column) == value
+        end
+      end
+    end
+    after_initialize do
+      send("#{column}=", values.first) unless send(column)
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  extend(StrEnum)
+end

data/str_enum.gemspec

@@ -0,0 +1,25 @@
+# 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

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: str_enum
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Kane
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- lib/str_enum.rb
+- lib/str_enum/version.rb
+- str_enum.gemspec
+homepage: https://github.com/ankane/str_enum
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: String enums for Rails
+test_files: []