new_data_magic 1.2

data/new_data_magic.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require File.expand_path('lib/data_magic/version', __dir__)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'new_data_magic'
+  gem.version       = DataMagic::VERSION
+  gem.platform      = Gem::Platform::RUBY
+  gem.authors       = ['Jeff Morgan','Lutfi Fitroh Hadi']
+  gem.email         = ['jeff.morgan@leandog.com','lutfi1304@gmail.com']
+  gem.license       = 'MIT'
+  gem.homepage      = 'http://github.com/firstlutfi/data_magic'
+  gem.summary       = 'Provides datasets to application via YAML files'
+  gem.description   = '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.required_ruby_version = '>= 2.5'
+
+  gem.add_dependency 'faker', '>= 1.9'
+  gem.add_dependency 'yml_reader', '>= 0.6'
+
+  gem.add_development_dependency 'cucumber', '>= 1.2.0'
+  gem.add_development_dependency 'rspec', '>= 2.12.0'
+end

data/spec/lib/data_magic_spec.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+class UserPage
+  include DataMagic
+end
+
+class MockScenario
+  attr_accessor :tags
+
+  def initialize(tags)
+    @tags = tags
+  end
+end
+
+class MockTag
+  attr_reader :name, :line
+
+  def initialize(name, line)
+    @name = name
+    @line = line
+  end
+end
+
+describe DataMagic do
+  context 'when configuring the yml directory' do
+    before(:each) do
+      DataMagic.yml_directory = nil
+    end
+
+    it 'should default to a directory named config' do
+      expect(DataMagic.yml_directory).to eql 'config/data'
+    end
+
+    it 'should store a yml directory' do
+      DataMagic.yml_directory = 'test_dir'
+      expect(DataMagic.yml_directory).to eql 'test_dir'
+    end
+
+    it 'should accept and use locale' do
+      expect(Faker::Config).to receive(:locale=).with('blah')
+      DataMagic.locale = 'blah'
+    end
+  end
+
+  context 'when reading yml files' do
+    it 'should read files from the config directory' do
+      DataMagic.yml = nil
+      DataMagic.load('user.yml')
+      data = UserPage.new.data_for 'valid'
+      expect(data.keys.sort).to eq(%w[job name])
+    end
+
+    it 'should default to reading a file named default.yml' do
+      DataMagic.yml_directory = 'config/data'
+      DataMagic.yml = nil
+      data = UserPage.new.data_for :dm
+      expect(data.keys).to include('value1')
+    end
+
+    it 'should use the value of DATA_MAGIC_FILE if it exists' do
+      DataMagic.yml_directory = 'config/data'
+      DataMagic.yml = nil
+      ENV['DATA_MAGIC_FILE'] = 'user.yml'
+      data = UserPage.new.data_for 'valid'
+      expect(data.keys.sort).to eq(%w[job name])
+      ENV['DATA_MAGIC_FILE'] = nil
+    end
+
+    it 'should merge additional data to the same key if not present in addtional' do
+      DataMagic.yml_directory = 'config/data'
+      data = UserPage.new.data_for 'user/valid', { 'job' => 'Overlord' }
+      expect(data['job']).to eq('Overlord')
+    end
+    it 'should merge additional data to resulting hash if present in additional data' do
+      DataMagic.yml_directory = 'config/data'
+      data = UserPage.new.data_for 'user/valid', { 'valid' => { 'job' => 'Overlord' } }
+      expect(data['job']).to eq('Overlord')
+    end
+  end
+
+  context 'namespaced keys' do
+    it 'loads correct file and retrieves data' do
+      DataMagic.yml_directory = 'config/data'
+      data = UserPage.new.data_for 'user/valid'
+      expect(data.keys.sort).to eq(%w[job name])
+    end
+  end
+
+  context 'loading fixtures for cucumber scenarios' do
+    it 'loads the fixture for a scenario' do
+      DataMagic.yml_directory = 'config/data'
+      scenario = MockScenario.new([MockTag.new('@tag', 1), MockTag.new('@datamagic_user', 1)])
+      expect(DataMagic).to receive(:load).with('user.yml')
+      DataMagic.load_for_scenario scenario
+    end
+
+    it 'uses the last fixture listed for a scenario if multiple exist' do
+      scenario = MockScenario.new([MockTag.new('@fixture_default', 1), MockTag.new('@datamagic_user', 1)])
+      expect(DataMagic).to receive(:load).with('user.yml')
+      DataMagic.load_for_scenario scenario
+    end
+
+    it 'allows you to force loading from a different folder without stepping on the global folder' do
+      DataMagic.yml_directory = 'features'
+      scenario = MockScenario.new([MockTag.new('@tag', 1), MockTag.new('@datamagic_user', 1)])
+      expect(DataMagic).to receive(:load).with('user.yml')
+      DataMagic.load_for_scenario scenario, 'config/data'
+      expect(DataMagic.yml_directory).to eq('features')
+    end
+  end
+end

data/spec/lib/translation_spec.rb

@@ -0,0 +1,326 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+describe 'DataMagic translations' do
+  context 'when delivering data' do
+    let(:example) { (Class.new { include DataMagic }).new }
+
+    def set_field_value(value)
+      expect(DataMagic).to receive(:yml).twice.and_return({ 'key' => { 'field' => value } })
+    end
+
+    it 'should deliver the hash from the yaml' do
+      set_field_value 'value'
+      expect(example.data_for('key')).to have_field_value 'value'
+    end
+
+    it 'should allow you to use a symbol for the key' do
+      set_field_value 'value'
+      expect(example.data_for(:key)).to have_field_value 'value'
+    end
+
+    it "should default to use a file named 'default.yml'" do
+      hsh = double('hash')
+      DataMagic.yml_directory = 'test'
+      expect(File).to receive(:read).with('test/default.yml')
+      expect(ERB).to receive(:new).and_return hsh
+      expect(hsh).to receive(:result)
+      expect(YAML).to receive(:load).and_return(test: 'test')
+      expect(DataMagic).to receive(:yml).and_return(nil)
+      expect(DataMagic).to receive(:yml).and_return({ 'key' => { 'field' => 'value' } })
+      expect(example.data_for('key')).to have_field_value 'value'
+    end
+
+    it 'should clone the data returned so it can be resued' do
+      yaml = double('yaml')
+      expect(yaml).to receive(:merge).and_return(yaml)
+      expect(DataMagic).to receive(:yml).twice.and_return(yaml)
+      expect(yaml).to receive(:[]).and_return(yaml)
+      expect(yaml).to receive(:deep_copy).and_return({ 'field' => 'value' })
+      expect(example.data_for('key')).to have_field_value 'value'
+    end
+
+    it 'should merge the provided data with the yaml data' do
+      yaml = double('yaml')
+      expect(DataMagic).to receive(:yml).twice.and_return(yaml)
+      expect(yaml).to receive(:[]).and_return(yaml)
+      expect(yaml).to receive(:merge).and_return(yaml)
+      expect(yaml).to receive(:deep_copy).and_return({ 'field' => 'value' })
+      expect(example.data_for('key')).to have_field_value 'value'
+    end
+
+    context 'translating random names' do
+      it 'should add a name' do
+        expect(Faker::Name).to receive(:name).and_return('Joseph')
+        set_field_value '~full_name'
+        expect(example.data_for('key')).to have_field_value 'Joseph'
+      end
+
+      it 'should add first name' do
+        expect(Faker::Name).to receive(:first_name).and_return('Sam')
+        set_field_value '~first_name'
+        expect(example.data_for('key')).to have_field_value 'Sam'
+      end
+
+      it 'should add last name' do
+        expect(Faker::Name).to receive(:last_name).and_return('Smith')
+        set_field_value '~last_name'
+        expect(example.data_for('key')).to have_field_value 'Smith'
+      end
+
+      it 'should add name prefix' do
+        expect(Faker::Name).to receive(:prefix).and_return('Mr')
+        set_field_value '~name_prefix'
+        expect(example.data_for('key')).to have_field_value 'Mr'
+      end
+
+      it 'should add name suffix' do
+        expect(Faker::Name).to receive(:suffix).and_return('Jr')
+        set_field_value '~name_suffix'
+        expect(example.data_for('key')).to have_field_value 'Jr'
+      end
+    end
+
+    context 'translating random addresses' do
+      it 'should add a street address' do
+        expect(Faker::Address).to receive(:street_address).and_return('123 Main')
+        set_field_value '~street_address'
+        expect(example.data_for('key')).to have_field_value '123 Main'
+      end
+
+      it 'should add a city' do
+        expect(Faker::Address).to receive(:city).and_return('Cleveland')
+        set_field_value '~city'
+        expect(example.data_for('key')).to have_field_value 'Cleveland'
+      end
+
+      it 'should add a state' do
+        expect(Faker::Address).to receive(:state).and_return('Ohio')
+        set_field_value '~state'
+        expect(example.data_for('key')).to have_field_value 'Ohio'
+      end
+
+      it 'should add a state abbreviation' do
+        expect(Faker::Address).to receive(:state_abbr).and_return('OH')
+        set_field_value '~state_abbr'
+        expect(example.data_for('key')).to have_field_value 'OH'
+      end
+
+      it 'should add a zip code' do
+        expect(Faker::Address).to receive(:zip).and_return('11111')
+        set_field_value '~zip_code'
+        expect(example.data_for('key')).to have_field_value '11111'
+      end
+
+      it 'should add a country' do
+        expect(Faker::Address).to receive(:country).and_return('United States')
+        set_field_value '~country'
+        expect(example.data_for('key')).to have_field_value 'United States'
+      end
+
+      it 'should add a secondary address' do
+        expect(Faker::Address).to receive(:secondary_address).and_return('2nd floor')
+        set_field_value '~secondary_address'
+        expect(example.data_for('key')).to have_field_value '2nd floor'
+      end
+    end
+
+    context 'translating company names' do
+      it 'should add a company name' do
+        expect(Faker::Company).to receive(:name).and_return('LeanDog')
+        set_field_value '~company_name'
+        expect(example.data_for('key')).to have_field_value 'LeanDog'
+      end
+    end
+
+    context 'translating business' do
+      it 'should add a credit card number' do
+        expect(Faker::Business).to receive(:credit_card_number).and_return('123')
+        set_field_value '~credit_card_number'
+        expect(example.data_for('key')).to have_field_value '123'
+      end
+
+      it 'should add credit card type' do
+        expect(Faker::Business).to receive(:credit_card_type)
+          .and_return('visa')
+        set_field_value '~credit_card_type'
+        expect(example.data_for('key')).to have_field_value 'visa'
+      end
+    end
+
+    context 'translating internet names' do
+      it 'should add an email address' do
+        expect(Faker::Internet).to receive(:email).and_return('buddy@example.com')
+        set_field_value '~email_address'
+        expect(example.data_for('key')).to have_field_value 'buddy@example.com'
+      end
+
+      it 'should add a domain name' do
+        expect(Faker::Internet).to receive(:domain_name).and_return('google.com')
+        set_field_value '~domain_name'
+        expect(example.data_for('key')).to have_field_value 'google.com'
+      end
+
+      it 'should add a user name' do
+        expect(Faker::Internet).to receive(:user_name).and_return('very_cheezy')
+        set_field_value '~user_name'
+        expect(example.data_for('key')).to have_field_value 'very_cheezy'
+      end
+    end
+
+    context 'translating phone numbers' do
+      it 'shold add a phone number' do
+        expect(Faker::PhoneNumber).to receive(:phone_number).and_return('555-555-5555')
+        set_field_value '~phone_number'
+        expect(example.data_for('key')).to have_field_value '555-555-5555'
+      end
+    end
+
+    context 'translating random phrases' do
+      it 'should add a catch phrase' do
+        expect(Faker::Company).to receive(:catch_phrase).and_return('Ruby is cool')
+        set_field_value '~catch_phrase'
+        expect(example.data_for('key')).to have_field_value 'Ruby is cool'
+      end
+
+      it 'should add random words' do
+        expect(Faker::Lorem).to receive(:words).and_return(%w[random words])
+        set_field_value '~words'
+        expect(example.data_for('key')).to have_field_value 'random words'
+      end
+
+      it 'should default to returning 3 words' do
+        set_field_value '~words'
+        expect(example.data_for('key')['field'].split.size).to eql 3
+      end
+
+      it 'should allow you to specify the number of words' do
+        set_field_value '~words(4)'
+        expect(example.data_for('key')['field'].split.size).to eql 4
+      end
+
+      it 'should add a random sentence' do
+        expect(Faker::Lorem).to receive(:sentence).and_return('a sentence')
+        set_field_value '~sentence'
+        expect(example.data_for('key')).to have_field_value 'a sentence'
+      end
+
+      it 'should default to returning a minimum of 4 words' do
+        set_field_value '~sentence'
+        expect(example.data_for('key')['field'].split.size).to be >= 4
+      end
+
+      it 'should allow you to specify a minimum word count' do
+        set_field_value '~sentence(20)'
+        expect(example.data_for('key')['field'].split.size).to be >= 20
+      end
+
+      it 'should add sentences' do
+        expect(Faker::Lorem).to receive(:sentences).and_return(['this is sentences'])
+        set_field_value '~sentences'
+        expect(example.data_for('key')).to have_field_value 'this is sentences'
+      end
+
+      it 'should default to returning a default of 3 sentences' do
+        set_field_value '~sentences'
+        expect(example.data_for('key')['field'].split('.').size).to be >= 3
+      end
+
+      it 'should allow you to specify the number of  sentences' do
+        set_field_value '~sentences(10)'
+        expect(example.data_for('key')['field'].split('.').size).to be >= 10
+      end
+
+      it 'should add a paragraphs' do
+        expect(Faker::Lorem).to receive(:paragraphs).and_return(['this is a paragraph'])
+        set_field_value '~paragraphs'
+        expect(example.data_for('key')).to have_field_value 'this is a paragraph'
+      end
+
+      it 'should return 3 paragraphs by default' do
+        set_field_value '~paragraphs'
+        expect(example.data_for('key')['field'].split('\n\n').size).to eql 3
+      end
+
+      it 'should allow you to specify the number of paragraphs' do
+        set_field_value '~paragraphs(10)'
+        expect(example.data_for('key')['field'].split('\n\n').size).to eql 10
+      end
+
+      it 'should add characters' do
+        expect(Faker::Lorem).to receive(:characters).and_return('abcdefg')
+        set_field_value '~characters'
+        expect(example.data_for('key')).to have_field_value 'abcdefg'
+      end
+    end
+
+    context 'translating boolean values' do
+      it 'should resolve true' do
+        set_field_value true
+        expect(example.data_for('key')).to have_field_value true
+      end
+
+      it 'should resolve false' do
+        set_field_value false
+        expect(example.data_for('key')).to have_field_value false
+      end
+    end
+
+    context 'with numeric values' do
+      it "doesn't translate values" do
+        set_field_value(1)
+        expect(example.data_for('key')).to have_field_value 1
+      end
+    end
+
+    context 'with values not in the yaml' do
+      it 'throws a ArgumentError' do
+        expect { example.data_for('inexistant_key') }.to raise_error ArgumentError
+      end
+    end
+
+    context 'providing date values' do
+      it "should provide today's date" do
+        set_field_value '~today'
+        expect(example.data_for('key')).to have_field_value Date.today.strftime('%D')
+      end
+
+      it "should provide tomorrow's date" do
+        set_field_value '~tomorrow'
+        tomorrow = Date.today + 1
+        expect(example.data_for('key')).to have_field_value tomorrow.strftime('%D')
+      end
+
+      it "should provide yesterday's date" do
+        set_field_value '~yesterday'
+        yesterday = Date.today - 1
+        expect(example.data_for('key')).to have_field_value yesterday.strftime('%D')
+      end
+
+      it 'should provide a date that is some number of days from now' do
+        set_field_value '~5.days_from_today'
+        the_date = Date.today + 5
+        expect(example.data_for('key')).to have_field_value the_date.strftime('%D')
+      end
+
+      it 'should provide a date that is some number of days ago' do
+        set_field_value '~5.days_ago'
+        the_date = Date.today - 5
+        expect(example.data_for('key')).to have_field_value the_date.strftime('%D')
+      end
+    end
+    context 'should fail when translation call methos is not defined' do
+      it 'should fail if method does not exist' do
+        set_field_value '~non_existing_method'
+        expect { example.data_for('key') }.to raise_error(/non_existing_method/)
+      end
+    end
+
+    context 'array translation test' do
+      it 'should be able to translate ' do
+        set_field_value ["~'user' + 'name'", 'second']
+        expect(example.data_for('key')).to have_field_value %w[username second]
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+if ENV['coverage']
+  raise 'simplecov only works on Ruby 1.9' unless RUBY_VERSION =~ /^1\.9/
+
+  require 'simplecov'
+  SimpleCov.start { add_filter 'spec/' }
+end
+
+require 'rspec'
+
+require 'data_magic'
+
+RSpec::Matchers.define :have_field_value do |expected|
+  supports_block_expectations
+  match do |actual|
+    actual['field'] === expected
+  end
+
+  failure_message do |actual|
+    "expected '#{expected}' to equal the field value '#{actual['field']}'"
+  end
+
+  failure_message_when_negated do |actual|
+    "expected '#{expected}' to not equal to field value '#{actual['field']}'"
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: new_data_magic
+version: !ruby/object:Gem::Version
+  version: '1.2'
+platform: ruby
+authors:
+- Jeff Morgan
+- Lutfi Fitroh Hadi
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: yml_reader
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+description: Provides datasets to application stored in YAML files
+email:
+- jeff.morgan@leandog.com
+- lutfi1304@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- ChangeLog
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- config/data/default.yml
+- config/data/user.yml
+- cucumber.yml
+- features/data_magic.feature
+- features/defaults.feature
+- features/step_definitions/data_magic_steps.rb
+- features/support/env.rb
+- features/yaml/another.yml
+- features/yaml/example.yml
+- lib/data_magic.rb
+- lib/data_magic/core_ext/hash.rb
+- lib/data_magic/core_ext/integer.rb
+- lib/data_magic/core_ext/string.rb
+- lib/data_magic/date_translation.rb
+- lib/data_magic/standard_translation.rb
+- lib/data_magic/translation.rb
+- lib/data_magic/version.rb
+- new_data_magic.gemspec
+- spec/lib/data_magic_spec.rb
+- spec/lib/translation_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/firstlutfi/data_magic
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.9
+signing_key:
+specification_version: 4
+summary: Provides datasets to application via YAML files
+test_files:
+- features/data_magic.feature
+- features/defaults.feature
+- features/step_definitions/data_magic_steps.rb
+- features/support/env.rb
+- features/yaml/another.yml
+- features/yaml/example.yml
+- spec/lib/data_magic_spec.rb
+- spec/lib/translation_spec.rb
+- spec/spec_helper.rb