keyword_struct 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 103673f24641358e2fb1c7121f628c854a83bd27
+  data.tar.gz: afee3c3b36fb40494645d29ff97877e2ed72d95d
+SHA512:
+  metadata.gz: 6416b7f54b1308f99233f2c59a95e38277c4c643cb458513913ee28b9691fb3a4ff43bde3342ef01a813bdee15fe3760b733df4bcc56bc3ccc8d7696dccce495
+  data.tar.gz: d87497b7733c65b92dd010ba625d9bf09c9db8180cc6976c5235c99a17d19755fd731ea295cc1b04017104643ba2d7c62c2dcddaf320e5078da792e6b1adc5ad

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.13.6

data/Gemfile

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

data/README.md

@@ -0,0 +1,49 @@
+# KeywordStruct
+
+[![Build Status](https://travis-ci.org/mru2/keyword_struct.svg?branch=master)](https://travis-ci.org/mru2/keyword_struct)
+
+Generates a struct-like class with the following properties :
+- only initializable via keyword arguments
+- all arguments are mandatory
+- only readers, no setters
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'keyword_struct'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install keyword_struct
+
+## Usage
+
+```ruby
+User = KeywordStruct.new(:first_name, :last_name) do
+  def full_name
+    [first_name, last_name].join(' ')
+  end
+end
+
+user = User.new(first_name: 'John', last_name: 'Doe')
+user.full_name
+# => "John Doe"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/mru2/keyword_struct.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "keyword_struct"
+
+# 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

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/keyword_struct.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'keyword_struct/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "keyword_struct"
+  spec.version       = KeywordStruct::VERSION
+  spec.authors       = ["mru2"]
+  spec.email         = ["david.ruyer+github@gmail.com"]
+
+  spec.summary       = %q{Read-only struct initialized with mandatory keyword arguments}
+  spec.homepage      = "https://github.com/mru2/keyword_struct"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/keyword_struct.rb

@@ -0,0 +1,28 @@
+require "keyword_struct/version"
+
+module KeywordStruct
+  def self.new(*attrs, &block)
+    Class.new do
+      # Define readers
+      attr_reader *attrs
+
+      define_method :initialize do |**kwargs|
+        # Check all arguments are present
+        missing_args = attrs.reject { |a| kwargs.key?(a) }
+
+        unless missing_args.empty?
+          message = (missing_args.length == 1) ? "missing keyword: #{missing_args.first}" : "missing keywords: #{missing_args.join(', ')}"
+          fail ArgumentError, message
+        end
+
+        # Store arguments
+        attrs.each do |attr|
+          instance_variable_set("@#{attr}", kwargs[attr])
+        end
+      end
+
+      # Custom methods
+      class_eval &block if block
+    end
+  end
+end

data/lib/keyword_struct/version.rb

@@ -0,0 +1,3 @@
+module KeywordStruct
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: keyword_struct
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- mru2
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- david.ruyer+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- keyword_struct.gemspec
+- lib/keyword_struct.rb
+- lib/keyword_struct/version.rb
+homepage: https://github.com/mru2/keyword_struct
+licenses: []
+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.6.7
+signing_key: 
+specification_version: 4
+summary: Read-only struct initialized with mandatory keyword arguments
+test_files: []