smart_options 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dd492a414f1ba09013d6c5cea3e4a7b29694da4b7627a46fadc84506332676e5
+  data.tar.gz: 5c7be0e32c31f6adbff54f1a6d9feff4de05762fd4f4254a556b00f7508b0072
+SHA512:
+  metadata.gz: 7ab18e0f19e2cbd65a2d8a3a3916a29517c783fe51c3524baee86a0b25cea00af07edff8be1467e7cd151cfc6863a87ad3ba4aded92fa6d86b464c8282df79a3
+  data.tar.gz: b8ce97bacd246c2dc20360cd698adad1fc8f22949f6db1bb300a2a29fdbb19851f81918b6b7ad14443cd932e1f76225b9d557fa149a4116768cb51fb769fb00c

data/.circleci/config.yml

@@ -0,0 +1,18 @@
+version: 2.1
+
+orbs:
+  ruby: circleci/ruby@0.1.2
+
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.6.3-stretch-node
+    steps:
+      - checkout
+      - run:
+          name: Which bundler?
+          command: bundle -v
+      - ruby/bundle-install
+      - run:
+          name: Run specs
+          command: bundle exec rspec

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in smart_options.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    smart_options (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3)
+  smart_options!
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Yuri Kasperovich
+
+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

@@ -0,0 +1,66 @@
+# SmartOptions
+
+[![CircleCI](https://circleci.com/gh/yukas/smart_options/tree/master.svg?style=svg)](https://circleci.com/gh/yukas/smart_options/tree/master)
+
+SmartOptions allows you to define options classes which have default and required options
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'smart_options'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install smart_options
+
+## Usage
+
+Inherit from SmartOptions class to get all functionality:
+
+```ruby
+class UserOptions < SmartOptions
+  option :first_name, required: true
+  option :last_name, required: true
+  option :admin, defaut: false
+end
+```
+
+User created options class:
+
+```ruby
+options = UserOptions.new(first_name: "Foo", last_name: "Bar")
+
+options.first_name # => "Foo"
+options.last_name # => "Bar"
+options.admin # => false
+
+options = UserOptions.new(last_name: "Bar") # => raises exception listing required options
+
+options = UserOptions.new(
+  first_name: "Foo",
+  last_name: "Bar",
+  middle_name: "Baz"
+) # => raises exception listing wrong options
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yukas/smart_options.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "smart_options"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/smart_options.rb

@@ -0,0 +1,5 @@
+require "smart_options/version"
+require "smart_options/options"
+
+module SmartOptions
+end

data/lib/smart_options/options.rb

@@ -0,0 +1,31 @@
+module SmartOptions
+  class Options
+    def self.option(name, params)
+      @@__options__ ||= {}
+      @@__options__[name] = params
+
+      define_method name do
+        instance_variable_get("@#{name}") || params[:default]
+      end
+
+      define_method :"#{name}=" do |value|
+        instance_variable_set("@#{name}", value)
+      end
+    end
+
+    def initialize(params = {})
+      wrong_keys = params.keys - @@__options__.keys
+
+      raise "Wrong options supplied: #{wrong_keys}" if !wrong_keys.empty?
+
+      required_options = @@__options__.select { |k, v| v[:required] }
+      missing_options_keys = required_options.keys - params.keys
+
+      raise "Missing required options: #{missing_options_keys}" if !missing_options_keys.empty?
+
+      params.each do |k, v|
+        instance_variable_set("@#{k}", v)
+      end
+    end
+  end
+end

data/lib/smart_options/version.rb

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

data/smart_options.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "smart_options/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "smart_options"
+  spec.version       = SmartOptions::VERSION
+  spec.authors       = ["Yuri Kasperovich"]
+  spec.email         = ["ykas.gg@gmail.com"]
+
+  spec.summary       = %q{Define custom options classes}
+  spec.description   = %q{SmartOptions allows to define options classes which have default and required options}
+  spec.homepage      = "https://github.com/yukas/smart_options"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: smart_options
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yuri Kasperovich
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: SmartOptions allows to define options classes which have default and
+  required options
+email:
+- ykas.gg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/smart_options.rb
+- lib/smart_options/options.rb
+- lib/smart_options/version.rb
+- smart_options.gemspec
+homepage: https://github.com/yukas/smart_options
+licenses:
+- MIT
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Define custom options classes
+test_files: []