flex_struct 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: caf46503e9a8152fa8f0e263643c8be5900ac8db
+  data.tar.gz: 1a5aefee1703e619e88c2fb4f0e618fcb832b98d
+SHA512:
+  metadata.gz: 8b0662189bbffdf683097d768121da164e5cbea58ad73f6866e7678a17d4dc0897fa94ee5df8039d645e1f2d59bea633ee7b0c366b95251bd2b34a8e6302e494
+  data.tar.gz: 1414dbe98a5a8e7fd03851ae85dbbc683e264bb0bf1757be5e3731877198f657850dcc5bf71ed04a3ab6e9a09dc94a0dc1327c7ed7f4b73ca15d886345af863d

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,70 @@
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+
+# Relates to the indentation of if/when/(etc.) blocks when the initial keyword
+# is indented as part of a variable assignment.
+#
+# Our preference is that the rubocop default conflicts with our 80-character
+# line restriction, leaving less space for code inside nested blocks. We make
+# this change at the cost of a little bit of readability.
+#
+#     # bad (although the Rubocop default):
+#     thing = if x > 42
+#               thing!
+#             else
+#               other_thing!
+#             end
+#
+#     # good (preferred):
+#     thing = if x > 42
+#       thing!
+#     else
+#       other_thing!
+#     end
+#
+#     # also acceptable
+#     thing =
+#       if x > 42
+#         thing!
+#       else
+#         other_thing!
+#       end
+Lint/EndAlignment:
+  EnforcedStyleAlignWith: variable
+  StyleGuide: https://github.com/BridgeU/bridgeu/commit/d19e558ec0246452a2962dcd6e6e5a915c1a8a6b
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+# Passing multiple hashes to a function is messy, and clarity is good
+# This is an extension of https://github.com/bbatsov/ruby-style-guide#no-braces-opts-hash
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+  StyleGuide: https://github.com/bbatsov/rubocop/issues/801
+
+# This is one part of the style guide that doesn't express a preference, it just
+# suggests you make a choice
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+Style/PercentLiteralDelimiters:
+  # Enforce Ruby style guide percent-delimiters
+  # Redundant with Rubocop 0.48.1
+  PreferredDelimiters:
+    default: ()
+    '%i': '[]'
+    '%I': '[]'
+    '%r': '{}'
+    '%w': '[]'
+    '%W': '[]'
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  StyleGuide: https://www.viget.com/articles/just-use-double-quoted-ruby-strings
+
+Style/PredicateName:
+  NamePrefixBlacklist:
+  - is_
+  - have_

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gemspec
+
+# Gems which aren't development dependencies, but are useful for development
+gem "guard-bundler"
+gem "guard-rspec"

data/Guardfile

@@ -0,0 +1,26 @@
+guard :bundler do
+  require "guard/bundler"
+  require "guard/bundler/verify"
+  helper = Guard::Bundler::Verify.new
+
+  files = ["Gemfile"]
+  files += Dir["*.gemspec"] if files.any? { |f| helper.uses_gemspec?(f) }
+
+  # Assume files are symlinked from somewhere
+  files.each { |file| watch(helper.real_path(file)) }
+end
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Gareth Adams
+
+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,121 @@
+# FlexStruct
+
+A drop-in replacement for Struct which adds a more flexible initialize method
+
+## Usage
+
+Create a `FlexStruct` very similarly to how you'd use any other `Struct`:
+
+    Pet = FlexStruct.new(:species, :name, :colour)
+
+However, `FlexStruct`-created classes can be initialized in more readable ways than
+default `Struct`s:
+
+    # Your only option with a Struct, positional arguments that require you to
+    # know which order the parameters were defined
+    floppy = Pet.new(:rabbit, "Floppy", :brown)
+
+    # Use hash/keyword arguments
+    fido = Pet.new(name: "Fido", species: :dog)
+
+    # Use block initialization
+    marmaduke = Pet.new do |pet|
+      pet.name = "Marmaduke"
+      pet.species = :cat
+      pet.colour = :tortoiseshell
+    end
+
+## Why?
+
+`Hash`es are great. You can use them to store arbitrary key/value pairs using
+any object as a key (although commonly people use `Symbol`s).
+
+However, `Hash`es are (by design) quite limited. Data is accessed using a small
+subset of method calls, so if you're passing data around your Ruby program in a
+`Hash`, every method using that data needs to know it's in a `Hash`(like) object.
+
+`OpenStruct`s are great. They behave a lot like a `Hash` that only has `Symbol`
+keys - you can set arbitrary values against any named property. You also get to
+get and set those values using regular Ruby methods, which means an `OpenStruct`
+can be often used as a substitute for any other Ruby object, thanks to duck
+typing. And to show how like-a-`Hash` it is, you can pass a `Hash` into its
+initializer and have all of the corresponding properties set.
+
+However, an `OpenStruct` will (by design) cheerfully respond `nil` to any
+property it doesn't explicitly know about, and let you set values for any
+property you like. While this is good in a lot of cases, you sometimes want
+data structures that (like most Ruby objects) have a fixed API. `OpenStruct`
+also has performance issues if you're going to create large numbers of them.
+
+`Struct`s are great. They're the most lightweight way to create a class with
+fixed attributes - you can create a data structure without having to worry about
+a lot of the `nil` issues that can crop up with the dynamic structures above.
+
+However, once you've created a `Struct` class, the initialize method can only be
+called using positional arguments - to initialize a `Struct` class with data, you
+need to know the order its properties were initialized with. That's not
+convenient or readable.
+
+## Yes, but why?
+
+`Struct`s are really useful classes that often make more sense than `Hash`es or
+`OpenStruct`s for a lot of their common use cases. But their inflexible
+initializers make them a pain to use.
+
+It's really easy to extend a Ruby `Struct` with new methods, including a better
+initializer, but the amount of boilerplate required turns what would otherwise
+be a one-liner class definition into a much heavier ugly addition.
+
+`FlexStruct` just creates regular `Struct`-based classes with this smarter
+initializer. The entire useful code of this gem is 14 lines, significantly
+smaller than even this section of the README!
+
+But to get people using data structures that are more useful, descriptive, and
+lightweight, it should be as easy as possible to create them. Hence:
+`FlexStruct`!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'flex_struct'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flex_struct
+
+## 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/gareth/flex_struct. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to
+the [Contributor Covenant](http://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).
+
+## Code of Conduct
+
+Everyone interacting in the FlexStruct project’s codebases, issue trackers, chat
+rooms and mailing lists is expected to follow the [code of
+conduct](https://github.com/gareth/flex_struct/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require "reek/rake/task"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = false
+end
+
+task default: %i[spec rubocop reek]

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "flex_struct"
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/flex_struct.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "flex_struct"
+
+Gem::Specification.new do |spec|
+  spec.name     = "flex_struct"
+  spec.version  = FlexStruct::VERSION
+  spec.authors  = ["Gareth Adams"]
+  spec.email    = ["gareth@bridge-u.com"]
+
+  spec.summary  = %(An extension to Struct with a more flexible initializer)
+  spec.homepage = "https://github.com/bridgeu/flex_struct"
+  spec.license  = "MIT"
+
+  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.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rubocop", "~> 0.48.1"
+  spec.add_development_dependency "reek", "~> 4.0"
+end

data/lib/flex_struct/version.rb

@@ -0,0 +1,3 @@
+class FlexStruct
+  VERSION = "0.1.0".freeze
+end

data/lib/flex_struct.rb

@@ -0,0 +1,14 @@
+# A drop-in replacement for Struct which adds a more flexible initialize method
+class FlexStruct
+  autoload :VERSION, "flex_struct/version"
+
+  def self.new(*args)
+    Struct.new(*args) do
+      def initialize(*args, **kwargs)
+        super(*args)
+        kwargs.each { |key, val| self[key] = val }
+        yield self if block_given?
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: flex_struct
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gareth Adams
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.48.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.48.1
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: 
+email:
+- gareth@bridge-u.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- flex_struct.gemspec
+- lib/flex_struct.rb
+- lib/flex_struct/version.rb
+homepage: https://github.com/bridgeu/flex_struct
+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.5.2
+signing_key: 
+specification_version: 4
+summary: An extension to Struct with a more flexible initializer
+test_files: []