vandelay 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d405003045d590b35b10831cbdcd80a2c80ff1cc
+  data.tar.gz: 75ef271c99e4cee9df35a41b3c33499e05f8532f
+SHA512:
+  metadata.gz: 90adbf845228d066261d560ed82694e5b56001de50c9c01025dcf4661dda6fe7a9c9ce0ae7725370087fc04df13bdb38e1952c27bede127357360af837e1edb8
+  data.tar.gz: b3c6442fb3ad028c836a679af8ce21d13ebf81600a1535c71f6216221e16f80637e06fc31f638538ed04c50fa4395c287ae36a3e007b4f1e2568acbdf599427d

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+vandelay

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.4

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 2.3.0
+  - 2.2.4
+  - 2.2.3
+  - 2.2.1
+  - 2.1.1
+  - 2.1.0
+
+before_install: gem install bundler -v 1.12.0
+script: bundle exec rspec
+

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2016 Dean Rex Silfen
+
+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,54 @@
+# Vandelay
+
+[![Build Status](https://travis-ci.org/djds23/Vandelay.svg?branch=master)](https://travis-ci.org/djds23/Vandelay)
+
+This is one implementation of the [Builder Pattern](https://en.wikipedia.org/wiki/Builder_pattern) in the Ruby programming language. This is primarily used for composing objects to transport a set of data to a receiver with a specific payload. The advantage of using a builder over a plain Hash is using explicit methods to set required fields, and getting a common way to present your data to the receiver. By default, `.build` will transform your data into a hash, but you can override this method to create your preferred format.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vandelay'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vandelay
+
+## Usage
+
+```ruby
+require 'vandelay'
+
+class ToDoBuilder
+  include Vandelay::Buildable
+
+  composed_of :text,
+              :title,
+              :completed_at
+
+  composed_of :created_at, default: Time.now.iso8601
+end
+
+new_todo = ToDoBuilder.new
+
+new_todo.set_title('Write a ruby package')
+new_todo.set_text('Ruby is fun to write, so why not write a gem?')
+new_todo.set_completed_at(Time.now.iso8601)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/djds23/vandelay.
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,6 @@
+require "vandelay/version"
+require "vandelay/buildable"
+
+module Vandelay
+end
+

data/lib/vandelay/buildable.rb

@@ -0,0 +1,68 @@
+module Vandelay
+  module Buildable
+    def self.included(base)
+
+      # Set default values on the base class so buildables
+      #  do not over write each other's defaults.
+      base.send :class_variable_set, :@@_internal_hash, {}
+      base.define_singleton_method(:__set_default) do |attribute, default|
+        self.send(:class_variable_get, :@@_internal_hash)[attribute] = default
+      end
+
+      base.send :include, InstanceMethods
+      base.extend ClassMethods
+    end
+
+    module InstanceMethods
+
+      # Returns a hash of all the attributes & their set values.
+      # Best to practice would be to override this for your required formats.
+      #
+      # def build
+      #   base = super
+      #
+      #   {
+      #     extra_fields: 'my_values',
+      #     buildable: base
+      #   }
+      # end
+      #
+      # @return [Hash] filled with attributes and set values
+      def build
+        attribute_hash
+      end
+
+      private
+      def attribute_hash
+        @@_internal_hash ||= {}
+      end
+
+      def update_attribute_hash(attribute, value)
+        attribute_hash[attribute] = value
+      end
+    end
+
+    module ClassMethods
+
+      # @param [Array] attributes fields that ought to be set on the builder
+      # @option [Object] default
+      def composed_of(*attributes, default: nil)
+        attributes.each do |attribute|
+          compose_setter(attribute, default)
+        end
+      end
+
+      private
+      def compose_setter(attribute, default)
+        __set_default(attribute, default)
+        define_method("set_#{attribute}") do |value|
+          instance_variable_set("@#{attribute}", value)
+          update_attribute_hash(attribute, value)
+
+          self
+        end
+      end
+    end
+  end
+end
+

data/lib/vandelay/version.rb

@@ -0,0 +1,3 @@
+module Vandelay
+  VERSION = "0.1.0"
+end

data/vandelay.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vandelay/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vandelay"
+  spec.version       = Vandelay::VERSION
+  spec.authors       = ["Dean Silfen"]
+  spec.email         = ["dean.silfen@gmail.com"]
+
+  spec.summary       = %q{An implmentation of the builder pattern for lightweight transport objects}
+  spec.description   = %q{This is one implementation of the [Builder Pattern](https://en.wikipedia.org/wiki/Builder_pattern) in the Ruby programming language. This is primarily used for composing objects to transport a set of data to a receiver with a specific payload. The advantage of using a builder over a plain Hash is using explicit methods to set required fields, and getting a common way to present your data to the receiver. By default, `.build` will transform your data into a hash, but you can override this method to create your preferred format.}
+  # spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  spec.required_ruby_version = '>= 2.1.0'
+  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.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1.0"
+  spec.add_development_dependency "yard", "~> 0.8.7.6"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: vandelay
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dean Silfen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+description: This is one implementation of the [Builder Pattern](https://en.wikipedia.org/wiki/Builder_pattern)
+  in the Ruby programming language. This is primarily used for composing objects to
+  transport a set of data to a receiver with a specific payload. The advantage of
+  using a builder over a plain Hash is using explicit methods to set required fields,
+  and getting a common way to present your data to the receiver. By default, `.build`
+  will transform your data into a hash, but you can override this method to create
+  your preferred format.
+email:
+- dean.silfen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/vandelay.rb
+- lib/vandelay/buildable.rb
+- lib/vandelay/version.rb
+- vandelay.gemspec
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: An implmentation of the builder pattern for lightweight transport objects
+test_files: []
+has_rdoc: