named_struct 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d9f07fc08fe47b747577f6c1f2a080295b437cc6
+  data.tar.gz: 380ce889316a7387b33c340279f5d81b7f052d20
+SHA512:
+  metadata.gz: 4008bbc5004c1351c88911570f423f992e1ff640a43fed8dc5564e7d5f3e849177b539cb22c7d3ba6a5ce7cec0b24951207070fac141a921d09933d169f7c18b
+  data.tar.gz: 8b24d41151be98eae8f3d48024f518147406f77911853d55f9c1926927b8dbb7d7c7c9ad3190417c82d6c93afc9138d25a4b18ada0833533ae68efdc73c32652

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in named_struct.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Max Shytikov
+
+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

@@ -0,0 +1,62 @@
+# NamedStruct
+
+Simple object to wrap your configuration, it can be instantiated only
+with required named arguments.
+
+Usually you do :
+
+```
+class MyConfig
+  att_reader :a, :b, :c
+
+  def initialize(a:, b:, c:)
+    @a = a
+    @b = b
+    @c = c
+  end
+
+end
+
+```
+
+But now you can :
+
+```
+class MyConfig < NamedStruct::Config
+   attr_required :a, :b, :c
+end
+
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'named_struct'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install named_struct
+
+## Usage
+
+```
+class MyConfig < NamedStruct::Config
+   attr_required :a, :b, :c
+end
+
+my_config = MyConfig.new(a: 10, b: 20, c: 30)
+
+class MySuperAlgorithm
+   def initialize(my_param, **config)
+      @my_param = my_param
+      @config = MyConfig.new(**config)
+   end
+end
+
+MySuperAlgirithm.new("some param", a: 12, b: 10, c: 50)
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/named_struct/config.rb

@@ -0,0 +1,34 @@
+module NamedStruct
+  class Config
+    class << self
+
+      attr_reader :members
+      def attr_required(*keys)
+        @members = keys
+        @members.freeze
+        attr_reader(*@members)
+      end
+
+    end
+
+    attr_required() # init this class with no required attributes
+
+    def initialize(*positional_args, **args)
+      if !positional_args.empty?
+        raise ArgumentError, "wrong arguments accepts only keyword arguments"
+      end
+      keys = args.keys
+      required_keys = self.class.members
+      if keys != required_keys
+        if keys.size > required_keys.size
+          raise(ArgumentError, "wrong number of arguments (%d for %d)"%
+                [keys.size, required_keys.size])
+        end
+        mising_keys = required_keys - keys
+        raise(ArgumentError, "missing keyword: %s"%mising_keys.join(', '))
+      end
+      args.each{|k, v| instance_variable_set("@#{k}".to_sym, v)}
+    end
+  end
+
+end

data/lib/named_struct/version.rb

@@ -0,0 +1,3 @@
+module NamedStruct
+  VERSION = "0.0.1"
+end

data/lib/named_struct.rb

@@ -0,0 +1,2 @@
+require "named_struct/version"
+require "named_struct/config"

data/named_struct.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'named_struct/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "named_struct"
+  spec.version       = NamedStruct::VERSION
+  spec.authors       = ["Max Shytikov"]
+  spec.email         = ["mshytikov@gmail.com"]
+  spec.summary       = %q{Simple Struct with required keyword arguments}
+  spec.description   = %q{Simple Struct with required keyword arguments}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-gem-adapter'
+end

data/spec/named_struct/config_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+RSpec.describe NamedStruct::Config do
+  describe ".new" do
+    context "without arguments" do
+      subject{ NamedStruct::Config.new}
+      it { is_expected.to be_kind_of(NamedStruct::Config) }
+      it { expect{ subject }.to_not raise_error }
+    end
+
+    context "with positional arguments" do
+      subject{ NamedStruct::Config.new(10, 20)}
+      let(:error_message) { "wrong arguments accepts only keyword arguments" }
+      it { expect{ subject }.to raise_error(ArgumentError, error_message)}
+    end
+
+    context "with keyword arguments" do
+      subject{ NamedStruct::Config.new(a: 10, b: 20)}
+      let(:error_message) { "wrong number of arguments (2 for 0)" }
+      it { expect{ subject }.to raise_error(ArgumentError, error_message)}
+    end
+  end
+
+  describe "class MyConfig < NamedStruct::Config" do
+    class MyConfig < NamedStruct::Config
+      attr_required :a, :b
+    end
+
+    describe '.members' do
+      subject{ MyConfig.members }
+      it { is_expected.to eq([:a, :b]) }
+      it { is_expected.to be_frozen }
+    end
+
+    context "without arguments" do
+      subject{ MyConfig.new}
+      let(:error_message) { "missing keyword: a, b" }
+      it { expect{ subject }.to raise_error(ArgumentError, error_message)}
+    end
+
+    context "with positional arguments" do
+      subject{ MyConfig.new(10, 20)}
+      let(:error_message) { "wrong arguments accepts only keyword arguments" }
+      it { expect{ subject }.to raise_error(ArgumentError, error_message)}
+    end
+
+    context "with keyword arguments" do
+      context "with all required arguments" do
+        subject{ MyConfig.new(a: 10, b: 11)}
+        it { is_expected.to be_kind_of(MyConfig) }
+        it { expect{ subject }.to_not raise_error }
+        it { is_expected.to respond_to(:a) }
+        it { is_expected.to respond_to(:b) }
+        it { is_expected.to_not respond_to(:a=) }
+        it { is_expected.to_not respond_to(:b=) }
+        it { expect(subject.a).to eq(10) }
+        it { expect(subject.b).to eq(11) }
+      end
+
+      context "with missing required arguments" do
+        context ":a is missing" do
+          subject{ MyConfig.new(b: 10)}
+          let(:error_message) { "missing keyword: a" }
+          it { expect{ subject }.to raise_error(ArgumentError, error_message)}
+        end
+        context ":b is missing" do
+          subject{ MyConfig.new(a: 10)}
+          let(:error_message) { "missing keyword: b" }
+          it { expect{ subject }.to raise_error(ArgumentError, error_message)}
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,86 @@
+require 'simplecov'
+require 'simplecov-gem-adapter'
+SimpleCov.start 'gem'
+
+require 'named_struct'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: named_struct
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Max Shytikov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: simplecov
+  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: simplecov-gem-adapter
+  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: Simple Struct with required keyword arguments
+email:
+- mshytikov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/named_struct.rb
+- lib/named_struct/config.rb
+- lib/named_struct/version.rb
+- named_struct.gemspec
+- spec/named_struct/config_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Simple Struct with required keyword arguments
+test_files:
+- spec/named_struct/config_spec.rb
+- spec/spec_helper.rb