padiddler 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jeremiah
+
+MIT License
+
+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,47 @@
+# Padiddler
+
+Sometimes data comes to you with a headlight out.
+
+## Description
+
+Maniuplate hashes from an external source so they work for your database setup.  Especially useful when reading data from external api or csv.  Instead of writing a messy conversion system, create easily testable Diddler objects to massage the data.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'paddiddler'
+
+## Usage
+
+First, get a sample piece of input that needs diddling.  In this example, the first name and last name don't need extra processing but the date of birth should be renamed and turned into a Date object.
+
+    input = {
+      first_name: 'Jeremiah',
+      last_name: 'Hemphill',
+      tel_no: '555-1234',
+      dob_year: '2014',
+      dob_month: '1',
+      dob_day: '24'
+    }
+
+Second, define your Diddler for the input
+
+    PersonDiddler < Padiddler::Base
+      # these instance variables should be made public with no changes
+      keep :first_name, :last_name
+
+      # these instance variable should be renamed in the output
+      rename :phone => :tel_no
+
+      # this additional output should be added
+      add :date_of_birth do
+        Date.parse("#{@dob_year}/#{@dob_month}/#{@dob_day}")
+      end
+    end
+
+Third, diddle away
+
+    input = get_input_from_csv
+    pdiddler = PersonDiddler.new(input)
+    Person.create(pdiddler.diddle)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/padiddler/base.rb

@@ -0,0 +1,68 @@
+module Padiddler
+  class Base
+    
+    class << self
+      # defines which attributes should be used in the output without changing their values
+      # 
+      # @param Array outputs an array of strings or symbols that correspond to instance variable names
+      def keep(*outputs)
+        outputs.each do |name|
+          instance_variable_accessor(name, name)
+        end
+      end 
+
+      # defines outputs whose names do not match the name of their instance variable
+      #
+      # @param Hash outputs Each pair should have the format :new_name => :original_name
+      def rename(outputs)
+        outputs.each_pair do |public_name, instance_var_name|
+          instance_variable_accessor(instance_var_name, public_name)
+        end
+      end
+
+      # adds a new output that is not directly related to an instance variable
+      # here to keep things consistent
+      #
+      # note that this functionality can be duplicated by just defining methods
+      #
+      # @param Symbol name The name of the output
+      def add(name, &block)
+        define_method(name.to_sym) { yield block }
+      end 
+
+      private
+
+      # create a name accessor for an instance variable
+      def instance_variable_accessor(var_name, name)
+        instance_var = instance_variable_name(var_name) 
+        define_method(name) { instance_variable_get(instance_var) }
+      end
+
+      # convenience method for turning a string into an instance variable symbol
+      # will take a string or symbol as an argument
+      # will add one @ to the front of the input
+      def instance_variable_name(name)
+        "@#{name.to_s}".to_sym
+      end
+    end
+
+    # Turns a hash into instance variables based on top level keys
+    # if the top level key is pointing to a hash, the value is not changed
+    def initialize(input = {})
+      input.each_pair do |key, value|
+        instance_variable_set(self.class.send(:instance_variable_name, key), value)
+      end
+    end 
+
+    # gets a list of public methods, assigns their name and value to a hash, and returns
+    # ignores private methods and methods that require arguments
+    def diddle
+      output = {}
+      output_methods = public_methods(false).select { |m| method(m).arity == 0 && m != :diddle }
+      output_methods.each do |name|
+        output[name] = send(name)
+      end
+      output
+    end 
+  end
+end

data/lib/padiddler/version.rb

@@ -0,0 +1,3 @@
+module Padiddler
+  VERSION = "0.0.2"
+end

data/lib/padiddler.rb

@@ -0,0 +1,7 @@
+require "padiddler/version"
+require_relative "./padiddler/base"
+
+# everything is in the base class
+# this is simpler than I thought it would be
+module Padiddler
+end

data/padiddler.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'padiddler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "padiddler"
+  spec.version       = Padiddler::VERSION
+  spec.authors       = ["Jeremiah"]
+  spec.email         = ["jeremiah@cloudspace.com"]
+  spec.summary       = %q{Convert external data into a more usable format}
+  spec.description   = %q{Convert external data into a more usable format}
+  spec.homepage      = "http://www.github.com/jeremiahishere/padiddler"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/padiddler/base_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+
+# the sample class to test on
+class SampleDiddler < Padiddler::Base
+end
+
+describe Padiddler::Base do
+  # after running each test, remove the methods we have added
+  after(:each) do
+    diddler = SampleDiddler.new({})
+    SampleDiddler.send(:remove_method, :first_name) if diddler.respond_to? :first_name
+    SampleDiddler.send(:remove_method, :middle_name) if diddler.respond_to? :middle_name
+    SampleDiddler.send(:remove_method, :last_name) if diddler.respond_to? :last_name
+    SampleDiddler.send(:remove_method, :hello) if diddler.respond_to? :hello
+  end
+
+  describe 'keep' do
+    it 'should take a list of symbols and define multiple instance methods' do
+      SampleDiddler.keep(:first_name, :last_name)
+      diddler = SampleDiddler.new
+      expect(diddler).to respond_to(:first_name)
+      expect(diddler).to respond_to(:last_name)
+    end
+
+    it 'should take a single symbol and define one instance method' do
+      SampleDiddler.keep(:middle_name)
+      diddler = SampleDiddler.new
+      expect(diddler).to respond_to(:middle_name)
+    end
+
+    it 'the new method should return the value of the instance variable with the same name' do
+      SampleDiddler.keep(:first_name, :last_name)
+      diddler = SampleDiddler.new
+      diddler.instance_variable_set(:@first_name, 'Jeremiah')
+      expect(diddler.first_name).to eq('Jeremiah')
+    end
+  end
+
+  describe 'rename' do
+    it 'should take a hash and define instance methods' do
+      SampleDiddler.rename(:first_name => :firstname)
+      diddler = SampleDiddler.new
+      expect(diddler).to respond_to(:first_name)
+      expect(diddler).not_to respond_to(:firstname)
+    end
+
+    it 'should return the instance referred to in the value of the key value pair' do
+      SampleDiddler.rename(:first_name => :firstname)
+      diddler = SampleDiddler.new
+      diddler.instance_variable_set(:@firstname, 'Jeremiah')
+      expect(diddler.first_name).to eq('Jeremiah')
+    end
+  end
+
+  describe 'add' do
+    it 'should create a new method with the name and body given by the arguments' do
+      SampleDiddler.add(:hello) { 'Hello World' }
+      diddler = SampleDiddler.new
+      expect(diddler.hello).to eq('Hello World') 
+    end
+  end
+
+  describe 'initialize' do
+    it 'should iterate over the hash and create instance variables' do
+      diddler = SampleDiddler.new(first_name: 'Jeremiah')
+      expect(diddler.instance_variables).to include(:@first_name)
+      expect(diddler.instance_variable_get(:@first_name)).to eq('Jeremiah')
+    end
+  end
+
+  describe 'diddle' do
+    before(:each) do
+      @diddler = SampleDiddler.new(first_name: 'Jeremiah', last_name: 'Hemphill')
+    end
+
+    it 'should iterate over public methods and return their outputs' do
+      def @diddler.first_name
+        @first_name
+      end
+
+      expect(@diddler.diddle).to eq(first_name: 'Jeremiah')
+    end
+
+    it 'should not include keys in the hash that were not excplicitly made public' do
+      expect(@diddler.diddle.keys).not_to include(:last_name)
+    end
+
+    it 'should not include private methods' do
+      SampleDiddler.send(:define_method, :first_name) do
+        @first_name
+      end
+      SampleDiddler.instance_eval { private :first_name }
+
+      expect(@diddler.diddle.keys).not_to include(:first_name)
+    end
+
+    it 'should not include methods that require arguments' do
+      def @diddler.first_name(arg)
+        @first_name + arg
+      end
+
+      expect(@diddler.diddle.keys).not_to include(:first_name)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+require 'padiddler'
+
+RSpec.configure do |config|
+  config.pattern = '**/*_spec.rb'
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: padiddler
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Jeremiah
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Convert external data into a more usable format
+email:
+- jeremiah@cloudspace.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/padiddler.rb
+- lib/padiddler/base.rb
+- lib/padiddler/version.rb
+- padiddler.gemspec
+- spec/padiddler/base_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.github.com/jeremiahishere/padiddler
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Convert external data into a more usable format
+test_files:
+- spec/padiddler/base_spec.rb
+- spec/spec_helper.rb
+has_rdoc: