strict_options 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd48360a5944716f242f2c5cc9f260262cad9c16
-  data.tar.gz: 8244ea83be1f05bf434c302ff9b569302f691bbc
+  metadata.gz: b5a74909f2f47d78ccd2ba1de2064a9165415731
+  data.tar.gz: 138c32ad3c2c3a355f87c39e1725016f2f800e11
 SHA512:
-  metadata.gz: d59a551d0682b058f236e00074300d70f9246c078cbd561fbfb55dba18c11159be4ec51f183ac443d3f8776d72da9fa9f23bf9ca1116594d45db6d4b75619a1a
-  data.tar.gz: 6c998326ab88f07711277e10e639f976073cc8e20be3bb02bceb852c8f88caa4f94e3fe057af161547d9303007639298907ebbeb74ca7ebdebc451effb77780b
+  metadata.gz: 8dc1b2b41b57543edabee7c09cdcea7515669c50f168d1328f07150fcb19912b924ffec36ecc1c4054149574707ffaa6c5f1ca47da0e2265f5cee6db67e944af
+  data.tar.gz: 9854ad600084821698a2ddba6998ad77a521e9ba4d24c7f773a885773a668ec7e810ae11cc2f236bf8c6bf26494a929cb4fa4beadb20a7b2ee97c20bf1a16bb8

data/README.md

@@ -0,0 +1,107 @@
+# StrictOptions
+
+## Description
+
+Allow you define strict attributes for options hash.
+
+Common practice in Ruby OOP are something like this:
+
+```ruby
+  class MyBestClass
+    def initialize(name, data, options = {})
+      @name    = name
+      @data    = data
+      @options = options
+    end
+
+    def some_method
+      raise ArgumentError, "No user set" unless options[:user]
+      raise ArgumentError, "No blah set" unless options[:blah]
+
+      # ... do something if user & blah was set
+    end
+  end
+```
+
+If you want some short method that allow raise `ArgumentError` (or some other Error) for all strict options you can use `strict_options!` method.
+
+## Installation & Setup
+
+Gemfile:
+```ruby
+gem 'strict_options'
+```
+and run `bundle` in console
+
+or for plain ruby-program:
+
+```ruby
+gem install strict_options
+```
+and in rubyfile:
+
+```ruby
+require 'strict_options'
+```
+
+## Example
+
+```ruby
+require 'strict_options'
+
+class Product
+  include StrictOptions
+
+  def initialize(name, options = {})
+    @name    = name
+    @options = options
+    @sku     = options.fetch(:sku,   nil)
+    @price   = options.fetch(:price, nil)
+    @brand   = options.fetch(:brand, nil)
+  end
+
+  def full_name
+    strict_options!(:brand, :sku)
+    "#{@brand} #{@name} (#{@sku})"
+  end
+
+  def dicounted_price
+    strict_options!(:price)
+    @price * 0.8
+  end
+end
+
+```
+And now you will control options attributes:
+
+```ruby
+p = Product.new("iPhone")
+p.full_name #=> options :brand, :sku are missing (ArgumentError)
+p.discounted_price #=> option :price is missing (ArgumentError)
+```
+and don't miss any attributes
+```ruby
+p = Product.new("iPhone", brand: "Apple", sku: "iphone_6s_16gb", price: 649)
+puts p.full_name #=> Apple iPhone (iphone_6s_16gb)
+puts p.discounted_price #=> 519.2
+```
+
+>Hold your hand at API pulse*
+
+## Features
+
+You could define you custom `ExceptionClass` and exception message:
+```ruby
+
+class PriceError < StandardError; end
+
+def calculate_sale_price
+  strict_options!(:price, exception_class: PriceError,
+                            exception_message: "No price!")
+end
+
+calculate_sale_price
+#=> #<PriceError: No price!>
+
+## TODO
+* Some improvements ? =)

data/lib/strict_options.rb

@@ -1,9 +1,12 @@
+require 'pry-rails'
+
 module StrictOptions
-  def strict_options!(*opts)
+  def strict_options!(*opts, exception_class: ArgumentError,
+                             exception_message: nil)
     @missings = []
     opts.each { |opt| @missings << ":#{opt}" unless @options[opt] }
-
-    raise ArgumentError, "option#{s} #{@missings.join(', ')} #{is_or_are} missing" if @missings.size > 0
+    msg = exception_message || "option#{s} #{@missings.join(', ')} #{is_or_are} missing"
+    raise exception_class, msg if @missings.size > 0
   end
 
   private

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: strict_options
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Volodya Sveredyuk
@@ -30,12 +30,27 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  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: Define strict attributes for options hash
 email: sveredyuk@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/strict_options.rb
 homepage: https://github.com/sveredyuk/strict_options
 licenses: