constantin 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0a1603331c80ac34581be1425b35c378d8de8be39702b01f2bd24a50a3a910d
-  data.tar.gz: 19512db49405c561624eb7751b99204b868bb072d1021fd1376241afa3fa0718
+  metadata.gz: cb52af75a34cd08d2ab154a4d70efe5318b6ce706a355089c23be235ec197409
+  data.tar.gz: 2576c5344799bc654068fc1bb4b98b330ba0e863c9633de598f39f7f02d44874
 SHA512:
-  metadata.gz: cf8cd5af61151ee94f7ba89cbc6267c4d89f5b5988304c5320d9bf5e0a2c5ac48aec4095a2aaff3f5e11518faca3d5facaef41dc258491bf81b2b23be4d21ca8
-  data.tar.gz: 2b920a3b467f5d9f03333ede46f9bc73016d8f22dbbe6a965c54be3f4159f99bf3477f066f749136d3bedf3297c91b696a30a6b3eddef9fd17328b335dfb97ff
+  metadata.gz: ec0d99930caf38417f83f1ce19296f805d8d18f54ed2f11da71ee329d9912fd093c56117c9fb60b342e8d16cac827d80fe83f58aa781ac4b1fe3b60ba5fd23ee
+  data.tar.gz: 41fdcf25eff731ef893fc4e5880110a52d0bc18ca750394f7526295b8065e3dc7c1e2801a4b7c087c694dda1618681f6d0707d32fa3aeb8b5a237f17dd7df770

data/README.md

@@ -1,8 +1,5 @@
 # Constantin
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/constantin`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A handy way to utilize constants especially on options.
 
 ## Installation
 
@@ -16,13 +13,40 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Usage
+
+```ruby
+# app/constants/country.rb
+class Country < Constantin::Constant
+  define_options 'US', 'PH', 'JP'
+  define_options { NZ: "New Zealand"}
+end
 
-    $ gem install constantin
+Country::ALL
+=> ['US', 'PH', 'JP', 'New Zealand']
 
-## Usage
+Country.constants
+=> [:US, :PH, :JP, :NZ]
 
-TODO: Write usage instructions here
+Country::US
+=> 'US'
+```
+
+Validate field in model against constants
+```ruby 
+class User
+  has_options :country, field: address
+end
+
+user = User.new
+user.address = "US"
+user.valid?
+=> true
+
+user.address = "NZ"
+user.valid?
+=> false
+```
 
 ## Development
 

data/lib/constantin.rb

@@ -1,5 +1,5 @@
 require "constantin/version"
-require "constantin/constant"
+require "constantin/option"
 require "constantin/active_record"
 
 module Constantin

data/lib/constantin/{constant.rb → option.rb}

@@ -1,5 +1,5 @@
 module Constantin
-  class Constant
+  class Option
     # Supports array of strings or hash
     # ex.
     # define_options('PH', 'TH', {'USA' => 'US'})

data/lib/constantin/version.rb

@@ -1,3 +1,3 @@
 module Constantin
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: constantin
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - jude_cali
@@ -87,7 +87,7 @@ files:
 - constantin.gemspec
 - lib/constantin.rb
 - lib/constantin/active_record.rb
-- lib/constantin/constant.rb
+- lib/constantin/option.rb
 - lib/constantin/version.rb
 homepage: https://github.com/disruptph/constantin
 licenses: