hashcraft 1.0.0.pre.alpha.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9dfbb2b3856098765290235f1fd1debd3fbd267cac38235e2aa2cf87fe35dac8
+  data.tar.gz: 41888aa7d9b3f977308d47039a3732d0b5d0973af8ab9bcd45f08ee986408027
+SHA512:
+  metadata.gz: de2140ec7116e7e284e11d7fe11eaa3266b91025f0e2235050492a9eef1bb35ceb88ab7557728acd808516413b25f6a85928e0190a9779a58447f2ef51f78e6f
+  data.tar.gz: 8a150eefc4294b49d65e7fc950d50a5ce01739c212863546624b3775cf00af5dd5fab320573f8f2a93e86beac53773299506d7de1f3a59affc2274bedd5ab716

data/.editorconfig

@@ -0,0 +1,8 @@
+# See http://editorconfig.org/
+
+[*]
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+end_of_line = lf

data/.gitignore

@@ -0,0 +1,8 @@
+.DS_Store
+*.gem
+/tmp
+/coverage
+Gemfile.lock
+/pkg
+
+

data/.rubocop.yml

@@ -0,0 +1,31 @@
+Layout/LineLength:
+  Max: 100
+  Exclude:
+    - hashcraft.gemspec
+
+Metrics/BlockLength:
+  ExcludedMethods:
+    - let
+    - it
+    - describe
+    - context
+    - specify
+    - define
+
+Metrics/MethodLength:
+  Max: 30
+
+AllCops:
+  TargetRubyVersion: 2.5
+
+Metrics/AbcSize:
+  Max: 16
+
+Metrics/ClassLength:
+  Max: 125
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.6.6

data/.travis.yml

@@ -0,0 +1,24 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=dfacb8b1a535e3d102b4353f2d3aa2bdd303bc139785a3a28a7d724e57a467ac
+language: ruby
+rvm:
+  # Build on the latest stable of all supported Rubies (https://www.ruby-lang.org/en/downloads/):
+  - 2.5.5
+  - 2.6.5
+  - 2.7.0
+cache: bundler
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rubocop
+  - bundle exec rspec spec --format documentation
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+addons:
+  # https://docs.travis-ci.com/user/uploading-artifacts/
+  artifacts:
+    paths:
+      - Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# 1.0.0 TBD
+
+Initial, feature-complete implementation.
+
+# 0.0.0 June 28th, 2020
+
+Initial library shell.

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 oss@bluemarblepayroll.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,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'DISABLE_SIMPLECOV=true bundle exec rspec --format=documentation' 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

@@ -0,0 +1,7 @@
+Copyright 2020 Blue Marble Payroll, LLC
+
+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,305 @@
+# Hashcraft
+
+[![Gem Version](https://badge.fury.io/rb/hashcraft.svg)](https://badge.fury.io/rb/hashcraft) [![Build Status](https://travis-ci.org/bluemarblepayroll/hashcraft.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/hashcraft) [![Maintainability](https://api.codeclimate.com/v1/badges/d0efe1bf0603a5dcd4e4/maintainability)](https://codeclimate.com/github/bluemarblepayroll/hashcraft/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/d0efe1bf0603a5dcd4e4/test_coverage)](https://codeclimate.com/github/bluemarblepayroll/hashcraft/test_coverage) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Provides a DSL for implementing classes which can then be consumed to create pre-defined hashes.  At Blue Marble we use this library to help define user interface components like grids, modals, panes, tabs, dialogs, etc.  It allows for our team to create code-first Ruby contracts for a React component library, essentially helping to create a "transpilation" pipeline: Ruby -> JSON -> React.
+
+## Installation
+
+To install through Rubygems:
+
+````
+gem install install hashcraft
+````
+
+You can also add this to your Gemfile:
+
+````
+bundle add hashcraft
+````
+
+## Getting Started
+
+### A Simple Example
+
+Imagine we want to build a Ruby class that defines a grid.  Imagine we would also like to use this class to derive grids from it, using the class as the "contract".  We could start with this:
+
+````ruby
+class Grid < Hashcraft::Base
+  option :api_url,
+         :name
+end
+````
+
+We could then derive grids from it using the constructor:
+
+````ruby
+config = Grid.new(api_url: '/patients', name: 'PatientsGrid').to_h
+````
+
+or using blocks:
+
+````ruby
+config = Grid.new do
+  api_url '/patients'
+  name 'PatientsGrid'
+end.to_h
+````
+
+Both net the same value for `config`:
+
+````ruby
+{
+  "api_url" => "/patients",
+  "name" => "PatientsGrid"
+}
+````
+
+But what if we want to add columns?  We could add two new building blocks: the column and the content (what goes in a column):
+
+````ruby
+class Content < Hashcraft::Base
+  option :property
+end
+
+class Column < Hashcraft::Base
+  option :header
+
+  option :content, craft: Content,
+                   mutator: :array,
+                   key: :contents
+end
+
+class Grid < Hashcraft::Base
+  option :api_url,
+         :name
+
+  option :column, craft: Column,
+                  mutator: :array,
+                  key: :columns
+end
+````
+
+Now that we have declared the overall structure of the contract, we can use it like this:
+
+````ruby
+config = Grid.new do
+  api_url '/patients'
+  name 'PatientsGrid'
+
+  column header: 'ID #' do
+    content property: :id
+  end
+
+  column header: 'First Name' do
+    content property: :first
+  end
+
+  column header: 'Last Name' do
+    content property: :last
+  end
+end.to_h
+````
+
+This would net us the following value for config:
+
+````ruby
+{
+  "api_url" => "/patients",
+  "name" => "PatientsGrid",
+  "columns" => [
+    {
+      "header" => "ID #",
+      "contents" => [
+        { "property" => :id }
+      ]
+    },
+    {
+      "header" => "First Name",
+      "contents" => [
+        { "property" => :first }
+      ]
+    },
+    {
+      "header" => "Last Name",
+      "contents" => [
+        { "property" => :last }
+      ]
+    }
+  ]
+}
+````
+
+### The Option API
+
+The minimal declaration of an available option for a class is as follows:
+
+````ruby
+class Grid < Hashcraft::Base
+  option :api_url
+end
+````
+
+This means there is an available method called api_url that can be called to set a key, called api_url, to its passed in value.  But there are several additional options available:
+
+* **craft**: Hashable::Base subclass constant used as a building block (Column in the above example.)  When defined it will be hydrated with the declared arguments and block and have #to_h called on it.
+* **default**: the value to initialize the key to, used in conjunction with eager.  When eager is true then this value will be used to set the key's default value to.  Note that this value will be simply overridden if it is declared at run-time.
+* **eager**: always assign a value.  When true it will always assign the key a value.
+* **key**: allows for aliasing keys.  If omitted, the key will be the option's method name (api_url as noted above).
+* **meta**: used to store any arbitrary data that can be accessed with transformers.
+* **mutator**: defines the type of the data backing the method, defaulting to property.  When the default property is used then it will simply assign the passed in value.  Other values are: `hash` and `array`.  When hash is used then the passed in value will be merged onto the key's value.  When array is used then the passed in value will be pushed onto the key's value.
+
+### Internationalization Support
+
+There is currently no first-class support for internationalization, but you can easily leverage the Option API meta field along with a custom value transformer to achieve this.  See the Transformers section for an example using Rails I18n mechanic.
+
+### Transformers
+
+Transformers are optional but come into play when you need any additional/special processing of keys and values.  By default, keys and values use the pass-thru transformer (Hashable::Transformers::PassThru) but can be explicitly passed any object that responds to `#transform(value, option)`.
+
+#### Key Transformer Example
+
+Say, for example, we wanted to transform all keys to camel case.  We could create our own transformer, such as:
+
+````ruby
+  class CamelCase
+    def transform(value, _option)
+      name = value.to_s.split('_').collect(&:capitalize).join
+
+      name[0, 1].downcase + name[1..-1]
+    end
+  end
+````
+
+We can then use this when deriving hashes (using the above Grid example):
+
+````ruby
+config = Grid.new do
+  api_url '/patients'
+end.to_h(key_transformer: CamelCase.new)
+````
+
+The resulting `config` value will now be:
+
+````ruby
+{
+  "apiUrl" => "/patients"
+}
+````
+
+Note that this library ships with some basic transformers like the one mentioned above.  If you want to use this then you can simply do this:
+
+````ruby
+config = Grid.new do
+  api_url '/patients'
+end.to_h(key_transformer: :camel_case)
+````
+
+See Hashcraft::TransformerRegistry for a full list of provided transformers.
+
+#### Value Transformer Example
+
+You can plug in internationalization by creating a custom value transformer and leveraging the Option API meta directive:
+
+````ruby
+class Localizer
+  def transform(value, option)
+    if option.meta(:localize)
+      I18n.l(value)
+    else
+      value
+    end
+  end
+end
+````
+
+Building on our Grid example, we could enhance the Column object as such:
+
+````ruby
+class Column < Hashcraft::Base
+  option :header, meta: { localize: true }
+
+  option :content, craft: Content,
+                   mutator: :array,
+                   key: :contents
+end
+````
+
+We can then use the new value transformer (Localizer) when deriving hashes (using the above Grid and updated Column example):
+
+````yaml
+en:
+  id: Identification Number
+  first: First Name
+````
+
+````ruby
+config = Grid.new do
+  column header: :id
+  column header: :first
+end.to_h(value_transformer: Localizer.new)
+````
+
+Assuming our en.yml looks like the above example and our locale is set to:en then the resulting `config` value will now be:
+
+````ruby
+{
+  "columns" => [
+    { header: 'Identification Number' },
+    { header: 'First Name' },
+  ]
+}
+````
+
+## Contributing
+
+### Development Environment Configuration
+
+Basic steps to take to get this repository compiling:
+
+1. Install [Ruby](https://www.ruby-lang.org/en/documentation/installation/) (check hashcraft.gemspec for versions supported)
+2. Install bundler (gem install bundler)
+3. Clone the repository (git clone git@github.com:bluemarblepayroll/hashcraft.git)
+4. Navigate to the root folder (cd hashcraft)
+5. Install dependencies (bundle)
+
+### Running Tests
+
+To execute the test suite run:
+
+````
+bundle exec rspec spec --format documentation
+````
+
+Alternatively, you can have Guard watch for changes:
+
+````
+bundle exec guard
+````
+
+Also, do not forget to run Rubocop:
+
+````
+bundle exec rubocop
+````
+
+### Publishing
+
+Note: ensure you have proper authorization before trying to publish new versions.
+
+After code changes have successfully gone through the Pull Request review process then the following steps should be followed for publishing new versions:
+
+1. Merge Pull Request into master
+2. Update `lib/hashcraft/version.rb` using [semantic versioning](https://semver.org/)
+3. Install dependencies: `bundle`
+4. Update `CHANGELOG.md` with release notes
+5. Commit & push master to remote and ensure CI builds master successfully
+6. 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).
+
+## Code of Conduct
+
+Everyone interacting in this codebase, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bluemarblepayroll/hashcraft/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+This project is MIT Licensed.