fig_magic 0.1

data/features/step_definitions/fig_newton_steps.rb

@@ -0,0 +1,95 @@
+Given (/^I have read the configuration file$/) do
+  FigMagic.yml_directory = 'config/yaml'
+  FigMagic.load 'test_config.yml'
+end
+
+When (/^I have read the default file from the default directory$/) do
+  FigMagic.yml = nil
+end
+
+When (/^I ask for the value for "([^\"]*)"$/) do |key|
+  @value = FigMagic.send key
+end
+
+Then (/^I should see "([^\"]*)"$/) do |value|
+  expect(@value).to eql value
+end
+
+Then (/^I should see (\d+)$/) do |value|
+  expect(@value).to eql value.to_i
+end
+
+Then (/^I should see true$/) do
+  expect(@value).to be true
+end
+
+Then (/^I should see false$/) do
+  expect(@value).to be false
+end
+
+When (/^I ask for a value that does not exist named "([^\"]*)"$/) do |non_existing|
+  @does_not_exist = non_existing
+end
+
+Then (/^I should raise a NoMethodError exception$/) do
+  expect{ FigMagic.send(@does_not_exist) }.to raise_error(NoMethodError)
+end
+
+Then (/^I should have a node$/) do
+  expect(@value).to be_an_instance_of FigMagic::Node
+end
+
+Then (/^the "([^\"]*)" value for the node should be "([^\"]*)"$/) do |key, value|
+  expect(@value.send(key)).to eql value
+end
+
+When (/^I ask for the node value for "([^\"]*)"$/) do |key|
+  @value = @value.send(key)
+end
+
+Given (/^I have an environment variable named "([^\"]*)" set to "([^\"]*)"$/) do |env_name, filename|
+  FigMagic.yml = nil
+  ENV[env_name] = filename
+  FigMagic.yml_directory = 'config/yaml'
+  FigMagic.instance_variable_set(:@yml, nil)
+end
+
+Then (/^the hash of values should look like:$/) do |table|
+  expect(table.transpose.hashes.first).to eql @value.to_hash
+end
+
+Given (/^I have a yml file that is named after the hostname$/) do
+  FigMagic.yml = nil
+  FigMagic.yml_directory = 'config/yaml'
+  @hostname = Socket.gethostname
+  File.open("config/yaml/#{@hostname}.yml", 'w') {|file| file.write("from_the_hostname_file:  read from the hostname file\n")}
+end
+
+Then (/^I should remove the file$/) do
+  File.delete("config/yaml/#{@hostname}.yml")
+end
+
+When (/^I ask for a value that does not exist named "(.+)" that has a default value "(.+)"$/) do |key, value|
+  @value = FigMagic.send key, value
+end
+
+When (/^I ask for a value that does not exist named "(.+)" that has a default block returning "(.+)"$/) do |key, value|
+  @value = FigMagic.send(key) {
+    value
+  }
+end
+
+When (/^I ask for a value that does not exist named "(.+)" that has a default lambda returning "(.+)"$/) do |key, value|
+  mylambda = lambda {|property| @lambda_property = property; return value}
+  @value = FigMagic.send key, &mylambda
+end
+
+When (/^I ask for a value that does not exist named "(.+)" that has a default proc returning "(.+)"$/) do |key, value|
+  myproc = Proc.new {value}
+  @value = FigMagic.send(key, &myproc)
+end
+
+Then (/^the lambda should be passed the property "(.+)"$/) do |expected_property|
+  expect(@lambda_property).to eq(expected_property)
+end
+

data/features/support/env.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '../../', 'lib'))
+
+require 'rspec/expectations'
+require 'fig_magic'
+
+Before do
+  FigMagic.yml_directory = nil
+  FigMagic.yml = nil
+end

data/features/yaml/another.yml

@@ -0,0 +1,9 @@
+other_file:
+  name: Sneezy
+  address: 555 Easy Money Drive
+  email: sneezy@example.com
+
+more_info:
+  name: Wheezy
+  address: 999 Alergy Ave
+  email: wheezy@example.com

data/features/yaml/example.yml

@@ -0,0 +1,56 @@
+dm:
+  value1: this is value 1
+  value2: this is value 2
+  full_name: ~full_name
+  first_name: ~first_name
+  last_name: ~last_name
+  name_prefix: ~name_prefix
+  name_suffix: ~name_suffix
+  street: ~street_address
+  street_plus:  ~street_address(true)
+  city: ~city
+  state: ~state
+  state_ab: ~state_abbr
+  zip: ~zip_code
+  country: ~country
+  second_address: ~secondary_address
+  company: ~company_name
+  email: ~email_address
+  email_plus: ~email_address('buddy')
+  domain_name: ~domain_name
+  url: ~url
+  user_name: ~user_name
+  phone: ~phone_number
+  cell: ~cell_phone
+  catch_phrase: ~catch_phrase
+  words: ~words
+  sentence: ~sentence
+  sentences: ~sentences
+  paragraphs: ~paragraphs
+  characters: ~characters
+  bool_true: true
+  bool_false: false
+  random: ~randomize ['Tom', 'Dick', 'Harry']
+  ordered: ~sequential ['first', 'second', 'third']
+  range:  ~randomize 1..5
+  mask: ~mask "###-AAA_aaa"
+  title: ~title
+  today: ~today
+  tomorrow: ~tomorrow
+  yesterday: ~yesterday
+  5daysfromtoday: ~5.days_from_today
+  5daysago: ~5.days_ago
+  some_month: ~month
+  month_abbr: ~month_abbr
+  some_day: ~day_of_week
+  day_abbr: ~day_of_week_abbr
+  this:
+    is_nested: Nested Value
+
+dynamic:
+  blah: ~blah
+
+other:
+  name: Cheezy
+  address: 123 Main Street
+  email: cheezy@example.com

data/fig_magic.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/fig_magic/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "fig_magic"
+  gem.version       = FigMagic::VERSION
+  gem.platform      = Gem::Platform::RUBY
+  gem.authors       = ["Justin Commu"]
+  gem.email         = ["jcommu@gmail.com"]
+  gem.license       = 'MIT'
+  gem.homepage      = "http://github.com/dingokiller/fig_magic"
+  gem.summary       = %q{Combines FigNewton & DataMagic into a single gem & namespace}
+  gem.description   = %q{Provides datasets to application stored in YAML files}
+  
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ["lib"]
+  
+  gem.add_dependency 'faker', '>= 1.1.2'
+  gem.add_dependency 'yml_reader', '>= 0.5'
+
+  gem.add_development_dependency 'rspec', '>= 2.12.0'
+  gem.add_development_dependency 'cucumber', '>= 1.2.0'
+end

data/lib/fig_magic/core_ext/fixnum.rb

@@ -0,0 +1,11 @@
+class Fixnum
+  def days_from_today(format = '%D')
+    the_day = Date.today + self
+    the_day.strftime(format)
+  end
+
+  def days_ago(format = '%D')
+    the_day = Date.today - self
+    the_day.strftime(format)
+  end
+end

data/lib/fig_magic/core_ext/string.rb

@@ -0,0 +1,5 @@
+class String
+  def is_integer
+    true if Integer(self) rescue false
+  end
+end

data/lib/fig_magic/date_translation.rb

@@ -0,0 +1,73 @@
+module FigMagic
+  module DateTranslation
+    #
+    # return today's date
+    #
+    # @param String the format to use for the date.  Default is %D
+    #
+    # See http://ruby-doc.org/stdlib-1.9.3/libdoc/date/rdoc/Date.html#method-i-strftime
+    # for details of the formats
+    #
+    def today(format = '%D')
+      Date.today.strftime(format)
+    end
+    alias_method :dm_today, :today
+
+    #
+    # return tomorrow's date
+    #
+    # @param String the format to use for the date.  Default is %D
+    #
+    # See http://ruby-doc.org/stdlib-1.9.3/libdoc/date/rdoc/Date.html#method-i-strftime
+    # for details of the formats
+    #
+    def tomorrow(format = '%D')
+      tomorrow = Date.today + 1
+      tomorrow.strftime(format)
+    end
+    alias_method :dm_tomorrow, :tomorrow
+
+    #
+    # return yesterday's date
+    #
+    # @param String the format to use for the date.  Default is %D
+    #
+    # See http://ruby-doc.org/stdlib-1.9.3/libdoc/date/rdoc/Date.html#method-i-strftime
+    # for details of the formats
+    #
+    def yesterday(format = '%D')
+      yesterday = Date.today - 1
+      yesterday.strftime(format)
+    end
+    alias_method :dm_yesterday, :yesterday
+
+    #
+    # return a month
+    #
+    def month
+      randomize(Date::MONTHNAMES[1..-1])
+    end
+    alias_method :dm_month, :month
+
+    #
+    # return a month abbreviation
+    #
+    def month_abbr
+      randomize(Date::ABBR_MONTHNAMES[1..-1])
+    end
+    alias_method :dm_month_abbr, :month_abbr
+
+    #
+    # return a day of the week
+    #
+    def day_of_week
+      randomize(Date::DAYNAMES)
+    end
+    alias_method :dm_day_of_week, :day_of_week
+
+    def day_of_week_abbr
+      randomize(Date::ABBR_DAYNAMES)
+    end
+    alias_method :dm_day_of_week_abbr, :day_of_week_abbr
+  end
+end

data/lib/fig_magic/missing.rb

@@ -0,0 +1,35 @@
+require 'yaml'
+require 'socket'
+
+module FigNewton
+  module Missing
+    def method_missing(*args, &block)
+      read_file unless @yml
+      m = args.first
+      value = @yml[m.to_s]
+      value = args[1] if value.nil?
+      value = block.call(m.to_s) if value.nil? and block
+      super if value.nil?
+      value = FigNewton::Node.new(value) unless type_known? value
+      value
+    end
+
+    def read_file
+      @yml = nil
+      @yml = YAML.load_file "#{yml_directory}/#{ENV['FIG_NEWTON_FILE']}" if ENV['FIG_NEWTON_FILE']
+      unless @yml
+        hostname = Socket.gethostname
+        hostfile = "#{yml_directory}/#{hostname}.yml"
+        @yml = YAML.load_file hostfile if File.exist? hostfile
+      end
+      FigNewton.load('default.yml') if @yml.nil?
+    end
+
+    private
+
+    def type_known?(value)
+      known_types = [String, Integer, TrueClass, FalseClass]
+      known_types.any? { |type| value.kind_of? type }
+    end
+  end
+end

data/lib/fig_magic/node.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + "/missing"
+
+module FigNewton
+  class Node
+    include FigNewton::Missing
+
+    def initialize(yml)
+      @yml = yml
+    end
+
+    def to_hash
+      @yml
+    end
+  end
+end

data/lib/fig_magic/standard_translation.rb

@@ -0,0 +1,316 @@
+module FigMagic
+  module StandardTranslation
+
+    attr_reader :parent
+
+    #
+    # return a random name (first and last)
+    #
+    def full_name
+      Faker::Name.name
+    end
+    alias_method :dm_full_name, :full_name
+
+    #
+    # return a random first name
+    #
+    def first_name
+      Faker::Name.first_name
+    end
+    alias_method :dm_first_name, :first_name
+
+    #
+    # return a random last name
+    #
+    def last_name
+      Faker::Name.last_name
+    end
+    alias_method :dm_last_name, :last_name
+
+    #
+    # return a random name prefix
+    #
+    def name_prefix
+      Faker::Name.prefix
+    end
+    alias_method :dm_name_prefix, :name_prefix
+
+    #
+    # return a random name suffix
+    #
+    def name_suffix
+      Faker::Name.suffix
+    end
+    alias_method :dm_name_suffix, :name_suffix
+
+    #
+    # return a random title
+    #
+    def title
+      Faker::Name.title
+    end
+    alias_method :dm_title, :title
+
+    #
+    # return a random street address
+    #
+    def street_address(include_secondary=false)
+      Faker::Address.street_address(include_secondary)
+    end
+    alias_method :dm_street_address, :street_address
+
+    #
+    # return a random secondary address
+    #
+    def secondary_address
+      Faker::Address.secondary_address
+    end
+    alias_method :dm_secondary_address, :secondary_address
+
+    #
+    # return a random city
+    #
+    def city
+      Faker::Address.city
+    end
+    alias_method :dm_city, :city
+
+    #
+    # return a random state
+    #
+    def state
+      Faker::Address.state
+    end
+    alias_method :dm_state, :state
+
+    #
+    # return a random state abbreviation
+    #
+    def state_abbr
+      Faker::Address.state_abbr
+    end
+    alias_method :dm_state_abbr, :state_abbr
+
+    #
+    # return a random 5 or 9 digit zip code
+    #
+    def zip_code
+      Faker::Address.zip
+    end
+    alias_method :dm_zip_code, :zip_code
+
+    #
+    # return a random country
+    #
+    def country
+      Faker::Address.country
+    end
+    alias_method :dm_country, :country
+
+
+    #
+    # return a random company name
+    #
+    def company_name
+      Faker::Company.name
+    end
+    alias_method :dm_company_name, :company_name
+
+    #
+    # return a random catch phrase
+    #
+    def catch_phrase
+      Faker::Company.catch_phrase
+    end
+    alias_method :dm_catch_phrase, :catch_phrase
+
+    #
+    # return a credit card number
+    #
+    def credit_card_number
+      Faker::Business.credit_card_number
+    end
+    alias_method :dm_credit_card_number, :credit_card_number
+
+    #
+    # return a credit card type
+    #
+    def credit_card_type
+      Faker::Business.credit_card_type
+    end
+    alias_method :dm_credit_card_type, :credit_card_type
+    
+    #
+    # return random words - default is 3 words
+    #
+    def words(number = 3)
+      Faker::Lorem.words(number).join(' ')
+    end
+    alias_method :dm_words, :words
+
+    #
+    # return a random sentence - default minimum word count is 4
+    #
+    def sentence(min_word_count = 4)
+      Faker::Lorem.sentence(min_word_count)
+    end
+    alias_method :dm_sentence, :sentence
+
+    #
+    # return random sentences - default is 3 sentences
+    #
+    def sentences(sentence_count = 3)
+      Faker::Lorem.sentences(sentence_count).join(' ')
+    end
+    alias_method :dm_sentences, :sentences
+
+    #
+    # return random paragraphs - default is 3 paragraphs
+    #
+    def paragraphs(paragraph_count = 3)
+      Faker::Lorem.paragraphs(paragraph_count).join('\n\n')
+    end
+    alias_method :dm_paragraphs, :paragraphs
+
+    #
+    # return random characters - default is 255 characters
+    #
+    def characters(character_count = 255)
+      Faker::Lorem.characters(character_count)
+    end
+    alias_method :dm_characters, :characters
+
+    #
+    # return a random email address
+    #
+    def email_address(name=nil)
+      Faker::Internet.email(name)
+    end
+    alias_method :dm_email_address, :email_address
+
+    #
+    # return a random domain name
+    #
+    def domain_name
+      Faker::Internet.domain_name
+    end
+    alias_method :dm_domain_name, :domain_name
+
+    #
+    # return a random url
+    #
+    def url
+      Faker::Internet.url
+    end
+    alias_method :dm_url, :url
+
+    #
+    # return a random user name
+    #
+    def user_name
+      Faker::Internet.user_name
+    end
+    alias_method :dm_user_name, :user_name
+
+    #
+    # return a random phone number
+    #
+    def phone_number
+      value = Faker::PhoneNumber.phone_number
+      remove_extension(value)
+    end
+    alias_method :dm_phone_number, :phone_number
+
+    #
+    # return a random cell number
+    #
+    def cell_phone
+      value = Faker::PhoneNumber.cell_phone
+      remove_extension(value)
+    end
+    alias_method :dm_cell_phone, :cell_phone
+
+    #
+    # return a random value from an array or range
+    #
+    def randomize(value)
+      case value
+      when Array then value[rand(value.size)]
+      when Range then rand((value.last+1) - value.first) + value.first
+      else value
+      end
+    end
+    alias_method :dm_randomize, :randomize
+
+    #
+    # return an element from the array.  The first request will return
+    # the first element, the second request will return the second,
+    # and so forth.
+    #
+    def sequential(value)
+      index = index_variable_for(value)
+      index = (index ? index + 1 : 0)
+      index = 0 if index == value.length
+      set_index_variable(value, index)
+      value[index]
+    end
+
+    #
+    # return a value based on a mast
+    # The # character will be replaced with a number
+    # The A character will be replaced with an upper case letter
+    # The a character will be replaced with a lower case letter
+    #
+    def mask(value)
+      result = ''
+      value.each_char do |ch|
+        case ch
+        when '#' then result += randomize(0..9).to_s
+        when 'A' then result += ('A'..'Z').to_a[rand(26)]
+        when 'a' then result += ('a'..'z').to_a[rand(26)]
+        else result += ch
+        end
+      end
+      result
+    end
+    alias_method :dm_mask, :mask
+
+
+
+    private
+
+    def set_index_variable(ary, value)
+      index_hash[index_name(ary)] = value
+    end
+
+    def index_variable_for(ary)
+      value = index_hash[index_name(ary)]
+      index_hash[index_name(ary)] = -1 unless value
+      index_hash[index_name(ary)]
+    end
+
+    def index_name(ary)
+      "#{ary[0]}#{ary[1]}_index".gsub(' ', '_').downcase
+    end
+
+    def index_hash
+      dh = data_hash[parent]
+      data_hash[parent] = {} unless dh
+      data_hash[parent]
+    end
+
+    def data_hash
+      $fig_magic_data_hash ||= {}
+    end
+
+    def process(value)
+      eval value
+    end
+
+    def remove_extension(phone)
+      index = phone.index('x')
+      phone = phone[0, (index-1)] if index
+      phone
+    end
+  end
+end

data/lib/fig_magic/translation.rb

@@ -0,0 +1,14 @@
+require 'fig_magic/date_translation'
+require 'fig_magic/standard_translation'
+
+module FigMagic
+  class Translation
+    include StandardTranslation
+    include DateTranslation
+
+    def initialize(parent)
+      @parent = parent
+    end
+
+  end
+end

data/lib/fig_magic/version.rb

@@ -0,0 +1,3 @@
+module FigMagic
+  VERSION = "0.1"
+end