str_enum 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1feedc135da7927cbe30d1b3adea0905a2c1cde
-  data.tar.gz: c07e9d2a957da6a464b60ba6c258adcbefeb445a
+  metadata.gz: 50458b9b15471d5a6656996aafd655245fba64fd
+  data.tar.gz: f04c3fa378db71e53714cd844fe99c776e0ca42f
 SHA512:
-  metadata.gz: 35f31098800bf578473e2edb8c46cb76134e63492addd325647f948c3754b2234f994af2ac132661ea2fa16ae17c0a0ec4b5804f85ba6d40354cdeb863ac5bd2
-  data.tar.gz: 5b99e03f4dd40a034ae6d8e86e52931e6894b78d8da234c4e597e26a03ec00e78ff1c04d01bc7a5027fabb551e9b58115fe27a3a51d017cf5be1de50c7bad89a
+  metadata.gz: f3eb2d10031cdf8a0b7967b02d2cf4624f0893480b05e8dbec893d1cc00e693a3c1acca73f4fc8fe361f4f4830f98e492f03eaf711bef7d29dfcadb67eae2414
+  data.tar.gz: 62c5e91bc1417967d641aec5865ce2120ad8b2fe01d2b09389bf205cc0778dc84b2a8401e386572f020e6aef9c4f5e5c7d1cc41083a9dcc5c12c2042bed8a46b

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 0.1.1
+
+- Added `prefix` option
+
+## 0.1.0
+
+- First release

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Andrew Kane
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,6 +1,6 @@
 # str_enum
 
-Don’t want to store enums as integers in your database? Introducing...
+Don’t like storing enums as integers in your database? Introducing...
 
 String enums for Rails!! :tada:
 
@@ -24,32 +24,32 @@ class User < ActiveRecord::Base
 end
 ```
 
-The first value will be the initial value. This gives you...
+The first value will be the initial value. This gives you:
 
-### Scopes
+#### Scopes
 
 ```ruby
 User.active
 User.archived
 ```
 
-### Validations
+#### Validations
 
 ```ruby
 user = User.new(status: "unknown")
 user.valid? # false
 ```
 
-### Accessor Methods
+#### Accessor Methods
 
 ```ruby
 user.active?
 user.archived?
 ```
 
-## Customize
+## Options
 
-Choose which features you want
+Choose which features you want with:
 
 ```ruby
 class User < ActiveRecord::Base
@@ -57,6 +57,26 @@ class User < ActiveRecord::Base
 end
 ```
 
+Prevent name collisions with the `prefix` option.
+
+```ruby
+class User < ActiveRecord::Base
+  str_enum :address_status, [:active, :archived], prefix: :address
+end
+
+# scopes
+User.address_active
+User.address_archived
+
+# accessor methods
+user.address_active?
+user.address_archived?
+```
+
+## History
+
+View the [changelog](https://github.com/ankane/str_enum/blob/master/CHANGELOG.md)
+
 ## Contributing
 
 Everyone is encouraged to help improve this project. Here are a few ways you can help:

data/lib/str_enum/version.rb

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

data/lib/str_enum.rb

@@ -2,13 +2,15 @@ require "str_enum/version"
 require "active_support"
 
 module StrEnum
-  def str_enum(column, values, validate: true, scopes: true, accessor_methods: true)
+  def str_enum(column, values, validate: true, scopes: true, accessor_methods: true, prefix: false)
     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
+      prefix = column if prefix == true
+      method_name = prefix ? "#{prefix}_#{value}" : value
+      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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: str_enum
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Andrew Kane
@@ -74,7 +74,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - lib/str_enum.rb