data_set 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ac070118f4ee9038a536c47001afdad19075b20
+  data.tar.gz: 15df8ee5fc9210d01d122108d9d2f5db9074ef5a
+SHA512:
+  metadata.gz: 08b5bfb4f398f665d8e8f3ebc7ecf8466489438a415d5e8823d04c8a39b8f72c724afca5c46ce5976116a6b75c3885a3d2bb263b343e265e55a27bb0c07df22b
+  data.tar.gz: 4bc6833d7258bb5ea04805e459a571f226068a996b88f2217493e375a05b0b6a04193e1cdadbb7f0822f37833e3955dd0bef25cb159c3885757297ca895bde18

data/.gitignore

@@ -0,0 +1,40 @@
+# Ruby-Specific
+
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+
+# Ouput-Specific
+
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.log
+*.tmp
+*.swp
+*.bak
+
+# IDE-Specific
+
+.idea
+.settings
+.project
+.classpath
+*.iws
+
+# Windows-Specific
+
+Thumbs.db
+
+# Mac OS-Specific
+
+*.DS_Store
+._*
+
+# Linux-Specific
+
+.directory
+.Trash-*

data/.hound.yml

@@ -0,0 +1,62 @@
+AllCops:
+  Exclude:
+    - data_set.gemspec
+    - test/*.rb
+    - spec/**/*
+
+# Removing need for frozen string literal comment.
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Removing the preference for string single quotes.
+Style/StringLiterals:
+  Enabled: false
+
+# Missing top-level module documentation comment.
+Style/Documentation:
+  Enabled: false
+
+# Prefer reduce over inject.
+Style/CollectionMethods:
+  PreferredMethods:
+    reduce: 'inject'
+
+# Use each_with_object instead of inject.
+Style/EachWithObject:
+  Enabled: false
+
+# Prefer fail over raise.
+Style/SignalException:
+  Enabled: false
+
+# This never works for validations.
+Style/AlignHash:
+  EnforcedLastArgumentHashStyle: ignore_implicit
+
+# Align multi-line params with previous line.
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+# Indent `when` clause one step from `case`.
+Style/CaseIndentation:
+  IndentOneStep: true
+
+# Don't force bad var names for reduce/inject loops.
+Style/SingleLineBlockParams:
+  Enabled: false
+
+# For method chains, keep the dot with the method name.
+Style/DotPosition:
+  EnforcedStyle: leading
+
+# Stop nesting so hard.
+Metrics/BlockNesting:
+  Max: 2
+
+# Encourage short methods.
+Metrics/MethodLength:
+  Max: 10
+
+# Encourage fewer parameters.
+Metrics/ParameterLists:
+  Max: 4

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_from:
+  - .hound.yml

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 jeffnyman@gmail.com. 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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in data_set.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jeff Nyman
+
+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,146 @@
+# DataSet
+
+[![Gem Version](https://badge.fury.io/rb/data_set.svg)](http://badge.fury.io/rb/data_set)
+[![License](http://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/jeffnyman/data_set/blob/master/LICENSE.txt)
+
+[![Dependency Status](https://gemnasium.com/jeffnyman/data_set.png)](https://gemnasium.com/jeffnyman/data_set)
+
+DataSet provides an easy mechanism to load up a set of data from a YAML file and then access that data by the structuring keys of the file. This provides an expressive way to retrieve data values.
+
+## Installation
+
+To get the latest stable release, add this line to your application's Gemfile:
+
+```ruby
+gem 'data_set'
+```
+
+And then include it in your bundle:
+
+    $ bundle
+
+You can also install DataSet just as you would any other gem:
+
+    $ gem install data_set
+
+## Usage
+
+To use DataSet you can either specify a directory and file for loading or rely on the defaults. By default, DataSet will look for files in a `data` directory relative to the executing script. Also by default, DataSet will read a file named `default.yml` from that directory. These defaults apply if you don't specify anything to the contrary.
+
+If you want to use a different directory you can simply set the directory like this:
+
+```ruby
+DataSet.data_path = 'config'
+```
+
+If you have a specific data file you want to load, you can specify it:
+
+```ruby
+DataSet.load('test_data.yml')
+```
+
+Calling the `load` method lets you begin to reference the data from that file. You can also specify a comma separated list of file names:
+
+```ruby
+DataSet.load('test_data.yml, accounts.yml, users.yml')
+```
+
+What DataSet is providing you is not just the loading of the file but a way to access the data directly by its name.
+
+### Data Accessors
+
+Consider a `test_data.yml` file with the following contents:
+
+```yaml
+home_url: 'https://veilus.herokuapp.com'
+port: 9292
+
+authentication:
+  username: admin
+  password: admin
+
+first:
+  second:
+    third: testing
+    fourth: xyzzy
+
+set_flag: true
+cleared_flag: false
+test_symbol: :marvel
+```
+
+Now you can load this file and begin calling methods on the DataSet that match the keys from the file.
+
+```ruby
+DataSet.load('test_data.yml')
+
+puts DataSet.home_url
+```
+
+Here the last statement would return "https://veilus.herokuapp.com". Using this in context, I might do something like this:
+
+```ruby
+puts "#{DataSet.home_url}/planets"
+```
+
+You can also supply default values which will be returned if the property does not exist in the file. For example:
+
+```ruby
+puts "#{DataSet.home_url("http://localhost")}:#{DataSet.port}/planets"
+```
+
+Here `home_url` will be read from the file but, if it doesn't exist, the value provided to it will be used.
+
+You can also access into the keys. For example, consider these statements:
+
+```ruby
+puts DataSet.authentication.username
+puts DataSet.first.second.third
+```
+
+These statements would return the following based on the above data file:
+
+```
+admin
+testing
+```
+
+You can also set an environment variable called `DATA_SET_FILE`. It's important to note that this is not a path. This is a file. The extent that this is useful depends on the context in which you slot it. Treating DataSet as an adjunct to an automated checking solution, for example, different machines that are using it could have different `DATA_SET_FILE` variables set. Or if using a tool like Cucumber, you could provide different profiles for execution like this:
+
+  ```yaml
+default:  DATA_SET_FILE=test.yml
+ci:       DATA_SET_FILE=ci.yml
+stage:    DATA_SET_FILE=staging.yml
+prod:     DATA_SET_FILE=production.yml
+```
+
+This would allow the specific environment variable to be set conditionally based on execution.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec:all` 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/jeffnyman/data_set](https://github.com/jeffnyman/data_set). The testing ecosystem of Ruby is very large and this project is intended to be a welcoming arena for collaboration on yet another testing tool. As such, contributors are very much welcome but are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+To contribute to DataSet:
+
+1. [Fork the project](http://gun.io/blog/how-to-github-fork-branch-and-pull-request/).
+2. Create your feature branch. (`git checkout -b my-new-feature`)
+3. Commit your changes. (`git commit -am 'new feature'`)
+4. Push the branch. (`git push origin my-new-feature`)
+5. Create a new [pull request](https://help.github.com/articles/using-pull-requests).
+
+## Author
+
+* [Jeff Nyman](http://testerstories.com)
+
+## Credits
+
+This code is loosely based upon the [FigNewton](https://github.com/cheezy/fig_newton) gem. I created a new version largely to avoid the name "FigNewton" as well as cleaning up the code and the documentation.
+
+## License
+
+DataSet is distributed under the [MIT](http://www.opensource.org/licenses/MIT) license.
+See the [LICENSE](https://github.com/jeffnyman/data_set/blob/master/LICENSE.txt) file for details.

data/Rakefile

@@ -0,0 +1,31 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rdoc/task"
+require "rubocop/rake_task"
+require "rspec/core/rake_task"
+
+RuboCop::RakeTask.new
+
+namespace :spec do
+  desc 'Clean all generated reports'
+  task :clean do
+    system('rm -rf spec/reports')
+  end
+
+  RSpec::Core::RakeTask.new(all: :clean) do |config|
+    options  = %w(--color)
+    options += %w(--format documentation)
+    options += %w(--format html --out spec/reports/unit-test-report.html)
+
+    config.rspec_opts = options
+  end
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.main = 'README.md'
+  rdoc.title = "DataSet #{DataSet::VERSION}"
+  rdoc.rdoc_files.include('README*', 'lib/**/*.rb')
+end
+
+task default: ['spec:all', :rubocop]

data/bin/console

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

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'data_set/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "data_set"
+  spec.version       = DataSet::VERSION
+  spec.authors       = ["Jeff Nyman"]
+  spec.email         = ["jeffnyman@gmail.com"]
+
+  spec.summary       = %q{Provides configuration specification and retrieval using YAML files.}
+  spec.description   = %q{Provides configuration specification and retrieval using YAML files.}
+  spec.homepage      = "https://github.com/jeffnyman/data_set"
+  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.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "pry"
+
+  spec.add_runtime_dependency "data_reader"
+
+  spec.post_install_message = %{
+(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)
+  DataSet #{DataSet::VERSION} has been installed.
+(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)
+  }
+end

data/lib/data_set/data_accessor.rb

@@ -0,0 +1,31 @@
+require "yaml"
+
+module DataSet
+  module DataAccessor
+    def method_missing(*args, &block)
+      load_data_source unless @data_source
+      key = args.first
+      value = @data_source[key.to_s]
+      value = args[1] if value.nil?
+      super if value.nil?
+      value = DataSet::DataElement.new(value) unless type_known?(value)
+      value
+    end
+
+    def respond_to_missing?; end
+
+    def load_data_source
+      @data_source = nil
+      path = "#{data_path}/#{ENV['DATA_SET_FILE']}"
+      @yml = YAML.load_file path if ENV['DATA_SET_FILE']
+      DataSet.load('default.yml') if @data_set.nil?
+    end
+
+    private
+
+    def type_known?(value)
+      known_types = [String, Integer, TrueClass, FalseClass, Symbol]
+      known_types.any? { |type| value.is_a?(type) }
+    end
+  end
+end

data/lib/data_set/data_element.rb

@@ -0,0 +1,11 @@
+require "data_set/data_accessor"
+
+module DataSet
+  class DataElement
+    include DataSet::DataAccessor
+
+    def initialize(value)
+      @data_source = value
+    end
+  end
+end

data/lib/data_set/version.rb

@@ -0,0 +1,3 @@
+module DataSet
+  VERSION = "1.0.0".freeze
+end

data/lib/data_set.rb

@@ -0,0 +1,18 @@
+require "data_set/version"
+require "data_set/data_element"
+require "data_set/data_accessor"
+
+require "data_reader"
+
+module DataSet
+  extend DataReader
+  extend DataSet::DataAccessor
+
+  class << self
+    attr_accessor :data
+
+    def default_data_path
+      'data'
+    end
+  end
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: data_set
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jeff Nyman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-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.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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: pry
+  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: data_reader
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides configuration specification and retrieval using YAML files.
+email:
+- jeffnyman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".hound.yml"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- data_set.gemspec
+- lib/data_set.rb
+- lib/data_set/data_accessor.rb
+- lib/data_set/data_element.rb
+- lib/data_set/version.rb
+homepage: https://github.com/jeffnyman/data_set
+licenses:
+- MIT
+metadata: {}
+post_install_message: "\n(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n
+  \ DataSet 1.0.0 has been installed.\n(::) (::) (::) (::) (::) (::) (::) (::) (::)
+  (::) (::) (::)\n  "
+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.1
+signing_key: 
+specification_version: 4
+summary: Provides configuration specification and retrieval using YAML files.
+test_files: []