ure 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6aee97285756be61b5d50c642d983b6fcc513b47
+  data.tar.gz: fd53cee9caf6a3afa0d824d89bcc2b5c6bd436af
+SHA512:
+  metadata.gz: 1637dd78f9d42d2aab243a61bf287e8f4ae1eb9e0387de4af3b745b612e60197198af9e4e1c789119cc78cfc4d3ac1f2a2e87112034479a9944a133ae690c348
+  data.tar.gz: 87a9c366245af1dc09e236615825ae0495acd331d8e377805c682614152d9d70f25f51b8c3c888d6ba5a58f600a4da1b766fef9d8630ed51e9398ec0859d0af4

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,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Calvyn82
+
+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,109 @@
+# Ure
+
+Ure is a Ruby Gem that fixes the biggest problems with Struct, namely the lack of immutability and required keyword arguments.
+
+For example, you can do this with Struct:
+
+```ruby
+Car = Struct.new(:paint, :year)
+=> Car
+scooby_van = Car.new
+=> #<struct Car paint=nil, year=nil>
+```
+
+Even worse, what if we include one argument and forget the other?
+
+```ruby
+myster_machine = Car.new(:mural)
+=> #<struct Car paint=:mural, year=nil>
+```
+Fixing it with Struct's built-in accessors after the fact isn't great, either. What we want is a Struct that has required arguments, and then throws a useful error if we give it the wrong thing.
+
+That's where Ure comes in.
+
+First, let's show a successful implementation of the same thing in Ure.
+
+```ruby
+require 'ure'
+=> true
+Car = Ure.new(:paint, :year)
+=> Car
+scooby_van = Car.new(year: 1965, paint: :mural)
+=> #ure {:year=>1968, :paint=>:mural}
+```
+Notice that it no longer matters what order `:year` and `:paint` are given to `Car`, because we have keyword arguments.
+
+But that's not all. 
+
+```ruby
+mystery_machine = Car.new
+NameError: uninitialized constant Ure::ArgumentError
+```
+
+We get a useful error message, instead of a data object populated with `nil`'s.
+
+Also, what happens if we try to change the values in an existing Ure data object?
+
+```ruby
+scooby_van = Car.new(year: 1965, paint: :mural)
+=> #ure {:year=>1968, :paint=>:mural}
+scooby_van.year = 2000
+NoMethodError: undefined method `year=' for #<ure {:year=>1965, :paint=>:mural}
+```
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ure'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ure
+
+## Usage
+
+To use Ure, just require it in whatever file is implementing it and treat it like a Struct.
+
+Ure will try to implement as public methods whatever keys you pass in as a hash. For speed purposes, this means that if you pass in an existing method that Ure recognizes, it'll override it. Ure inherits directly from `BasicObject`, so it has very few methods other than its public facing instance methods. Still, this is something to watch out for. If you're passing in ':instance_eval` or a lone `!` as keys, you'll have problems.
+
+Any methods on `Struct` that require indexing or care about the position of arguments have been depricated or changed to only care about the name of the argument passed.
+
+Ure's current public methods are:
+
+`#[]` - Because Ure doesn't care about indexing, this allows users to treat instances of Ure as a hash.
+
+`#each(&block) - Converts the fields into a hash and calls each on them.
+
+`#to_s` - Returns a string describing the object and its fields.
+
+`#inspect`- Alians for `.to_s`
+
+`#to_a` - Alias for `.values`.
+
+`#to_h` - Returns a hash of the fields.
+
+`#values` - Returns an array of the values in the fields.
+
+`#values_at` - Takes one or more keys as arguments, and returns an array of the corresponding values.
+
+## 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/Calvyn82/ure. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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 "ure"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ure.rb

@@ -0,0 +1,85 @@
+require "ure/version"
+class Ure < BasicObject
+  def self.members
+    @members
+  end
+
+  def self.new(*members, &body)
+    ::Class.new(self) do
+      instance_variable_set(:@members, members)
+
+      def self.new(*args, &block)
+        object = allocate
+        object.__send__(:initialize, *args, &block) if respond_to?(:initialize, true)
+        object
+      end 
+
+      define_method(:members) do
+        @members ||= members
+      end
+
+      class_eval(&body) if body
+    end
+  end
+
+  def initialize(fields = {})
+    fail "'fields' must be a 'Hash'" unless fields.is_a?(::Hash)
+
+    members.each do |member|
+      fail ArgumentError, "missing keyword: #{member}" unless fields.include?(member)
+      instance_eval <<-END_RUBY
+      def #{member}
+        i = members.index(#{member.inspect})
+        values[i]
+      end
+      END_RUBY
+    end
+
+    unless (extra = fields.keys - members).empty?
+      fail ArgumentError,
+        "unknown keyword#{'s' if extra.size > 1}: #{extra.join(', ')}"
+    end
+
+    @values = fields
+    @fields = fields
+  end
+
+  attr_reader :fields
+
+  def [](key)
+    fields[key]
+  end
+
+  def each(&block)
+    to_h.each(&block)
+  end
+
+  def to_s
+    "#<ure #{fields.to_s}"
+  end
+
+  def inspect
+    to_s
+  end
+
+  def to_a
+    fields.values
+  end
+
+  def to_h
+    fields.to_h
+  end
+
+  def values
+    fields.values
+  end
+
+  def values_at(name, *args)
+    list = []
+    list << fields[name]
+    args.each do |arg|
+      list << fields[arg]
+    end
+    list
+  end
+end

data/lib/ure/version.rb

@@ -0,0 +1,3 @@
+class Ure < BasicObject
+  VERSION = "0.0.2"
+end

data/ure.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ure/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ure"
+  spec.version       = Ure::VERSION
+  spec.authors       = ["Clayton Flesher", "James Edward Grey II"]
+  spec.email         = ["claytonflesher@gmail.com"]
+
+  spec.summary       = %q{Immutable value objects for ruby that include required keyword arguments.}
+  spec.description   = %q{A replacement for Struct that is immutable and has required keyword arguments.}
+  spec.homepage      = "https://github.com/Calvyn82/ure"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+  else
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: ure
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Clayton Flesher
+- James Edward Grey II
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+description: A replacement for Struct that is immutable and has required keyword arguments.
+email:
+- claytonflesher@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ure.rb
+- lib/ure/version.rb
+- ure-0.0.1.gem
+- ure.gemspec
+homepage: https://github.com/Calvyn82/ure
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Immutable value objects for ruby that include required keyword arguments.
+test_files: []