ditto 0.0.1

data/CHANGELOG

@@ -0,0 +1 @@
+Version 0.0.1: Initial attempts

data/README

@@ -0,0 +1,11 @@
+Database Independent Test Objects (Ditto)
+
+Ditto defines a simple DSL that allows test data to be expressed in a database independent format. When the underlying tables are remapped the QA team don't have to go and change all the historical test cases.
+
+There are two parts, both of them versioned:
+1. The data declarations
+2. The mappings to the underlying database
+
+Idea is to replace an XML dialect with something simpler. See sample at simple_object.xml
+
+Nick Townsend, Oct 2012

data/bin/ditto

@@ -0,0 +1,4 @@
+#!/usr/bin/ruby
+require 'ditto/runner'
+runner = Ditto::Runner.new(ARGV)
+runner.run

data/ditto.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name        = 'ditto'
+  s.version     = '0.0.1'
+  s.date        = '2012-10-12'
+  s.summary     = "Database independent test objects"
+  s.description = File.read(File.join(File.dirname(__FILE__), 'README'))
+  s.authors     = ["Nick Townsend"]
+  s.email       = 'nick.townsend@mac.com'
+  s.platform	= Gem::Platform::RUBY
+  s.required_ruby_version = '>=1.9' 
+  s.files	= Dir['**/**']
+  s.homepage    = 'http://rubygems.org/gems/ditto'
+#  s.add_runtime_dependency "daemons", ["= 1.1.0"]
+  s.add_development_dependency "rspec", [">= 0"]
+  s.has_rdoc	= false
+end

data/features/create_entities.feature

@@ -0,0 +1,81 @@
+Feature: Ditto parses simple entities
+In order to create test data definitions
+As a user of Ditto
+I want to load data entity definitions
+
+Scenario: Ditto parses a single correct entity
+  Given a file named "simple_entity.rb" with:
+  """
+  require 'ditto'
+
+  entity :currency, {
+    code:	    [ :mandatory, :unique ],
+    description:    nil,
+    exchange_rate:  :mandatory,
+    is_designated:  nil,
+  }
+  check!
+  """
+  When I run "simple_entity.rb" 
+  Then the exit code should be 0
+  And the stdout should be
+  """ 
+  Entities:
+  currency
+  1 entities, 0 relationships, 0 errors
+
+  """
+
+Scenario: Ditto parses a faulty entity attribute
+  Given a file named "faulty_attribute.rb" with:
+  """
+  require 'ditto'
+
+  entity :currency, {
+    code:	    [ :mandatory, :unique, :radar ],
+    description:    nil,
+    exchange_rate:  :mandatory,
+    is_designated:  nil,
+  }
+  check!
+  """
+  When I run "faulty_attribute.rb" 
+  Then the exit code should be 1
+  And the stdout should be
+  """ 
+  Entities:
+  currency
+  unknown properties: radar
+  1 entities, 0 relationships, 1 errors
+
+  """
+
+Scenario: Ditto parses a correct entity relationship
+  Given a file named "simple_relationship.rb" with:
+  """
+  require 'ditto'
+
+  entity :currency, {
+    code:	    [ :mandatory, :unique ],
+    description:    nil,
+    exchange_rate:  :mandatory,
+    is_designated:  nil,
+    currency_group: :related
+  }
+  entity :currency_group, {
+    :code => [ :mandatory, :unique ],
+    :description => nil,
+    :is_commodity => nil
+  }
+  check!
+  """
+  When I run "simple_relationship.rb" 
+  Then the exit code should be 0
+  And the stdout should be
+  """ 
+  Entities:
+  currency
+  currency_group
+  2 entities, 1 relationships, 0 errors
+
+  """

data/features/load_entity.feature

@@ -0,0 +1,33 @@
+Feature: Ditto loads simple entities
+In order to create test data
+As a user of Ditto
+I want to load data definitions
+
+Scenario: Ditto loads a simple entity
+  Given a file named "simple_entity_data.rb" with:
+  """
+  version: 1.0.0
+  date:    2012-10-13
+  --- 
+  currency:
+    code: GBP
+    description: Pounds Sterling
+    exchange_rate: 1.5
+    is_designated: false
+    currency_group: Europe
+  ---
+    currency_group:
+      code: Europe
+      description: European Countries
+      is_commodity: false
+    version: 1.0.1
+  """
+  When I run ditto on "simple_entity.rb" 
+  Then the exit code should be 0
+  And the stdout should be
+  """ 
+  Data Entities:
+  currency {"code"=>"GBP", "description"=>"Pounds Sterling", "exchange_rate"=>1.5, "is_designated"=>false, "currency_group"=>"Europe"}
+  currency_group {"code"=>"Europe", "description"=>"European Countries", "is_commodity"=>false}
+  2 entities, 1 relationships, 0 errors 
+  """

data/features/step_definitions/definition_steps.rb

@@ -0,0 +1,21 @@
+require 'tmpdir'
+
+Given /^a file named "(.*?)" with:$/ do |arg1, string|
+  filename = "#{Dir.tmpdir}/#{arg1}"
+  File.open(filename,"w") { |f| f.write string }
+  @files[arg1] = filename
+end
+
+When /^I run "(.*?)"$/ do |arg1|
+  @out = `ruby -I lib #{@files[arg1]}`
+  raise "Exec failed!" if $?.success?.nil?
+  @rc = $?.exitstatus
+end
+
+Then /^the exit code should be (\d+)$/ do |arg1|
+  @rc.should == arg1.to_i
+end
+
+Then /^the stdout should be$/ do |string|
+  @out.should == string
+end

data/features/support/hooks.rb

@@ -0,0 +1,3 @@
+Before do
+  @files = {}
+end

data/lib/ditto.rb

@@ -0,0 +1,3 @@
+require_relative 'ditto/entity'
+require_relative 'ditto/dsl'
+include Ditto::DSL

data/lib/ditto/dsl.rb

@@ -0,0 +1,13 @@
+# Define the DSL for Ditto
+#
+module Ditto
+  module DSL
+    def entity (*args, &block)
+      Ditto::Entity.define_entity(*args, &block)
+    end
+    def check! (*args, &block)
+      nerr = Ditto::Entity.check(*args, &block)
+      exit(nerr)
+    end
+  end
+end

data/lib/ditto/entity.rb

@@ -0,0 +1,34 @@
+# Entity support for Ditto
+#
+module Ditto
+  class Entity
+    PROPS = [ :mandatory, :unique, :related ].freeze
+    @entities = {}
+    def self.define_entity name, details
+      raise "Entity details must be a hash!" unless details.kind_of? Hash
+      raise "Entity #{name.to_sym} already exists" if @entities.has_key?(name.to_sym)
+      @entities[name.to_sym] = details
+    end
+    def self.check
+      nrel = 0
+      nerr = 0
+      nkey = 0
+      puts "Entities:"
+      @entities.each do |name,fields|
+	puts name
+	fields.each do |field, props|
+	  symprops = Array(props).select{|p| p.is_a? Symbol}
+	  duffprops = symprops - PROPS
+	  unless duffprops.empty?
+	    puts "unknown properties: #{duffprops.join(' ,')}"
+	    nerr += 1
+	  end
+	  nkey += symprops.count(:unique)
+	  nrel += symprops.count(:related)
+	end
+      end
+      puts "#{@entities.size} entities, #{nrel} relationships, #{nerr} errors"
+      return nerr
+    end
+  end
+end

data/lib/ditto/options.rb

@@ -0,0 +1,33 @@
+require 'optparse'
+
+module Ditto
+  class Options
+    DEFAULT_CONNSTRING = "user/password@//localhost:1521/test"
+    attr_reader :connstring, :files_to_load
+    def initialize(argv)
+      @connstring = DEFAULT_CONNSTRING
+      parse(argv)
+      @files_to_load = argv
+    end
+    private
+    def parse(argv) 
+      OptionParser.new do |opts|
+	opts.banner = "Usage: ditto [ options ] files..."
+	opts.on("-d", "--database string", String, "DB Connection string") do |s|
+	  @connstring = s
+	end
+	opts.on("-h", "--help", "Show this message") do
+	  puts opts
+	  exit
+	end
+	begin
+	  argv = ["-h"] if argv.empty?
+	  opts.parse!(argv)
+	rescue OptionParser::ParseError => e
+	  STDERR.puts e.message, "\n", opts
+	  exit(-1)
+	end
+      end
+    end
+  end
+end

data/lib/ditto/runner.rb

@@ -0,0 +1,13 @@
+require_relative 'dsl'
+require_relative 'options'
+
+module Ditto
+  class Runner
+    def initialize(argv)
+      @options = Options.new(argv)
+    end
+    def run
+      puts "Ditto has run with options #{@options}"
+    end
+  end
+end

data/rakefile

@@ -0,0 +1,8 @@
+# Rakefile for Ditto
+#
+task :default => :test
+
+task :test do
+  sh "rspec -c"
+  sh "cucumber -f progress features"
+end

data/samples/simple_object.xml

@@ -0,0 +1,23 @@
+---------------------------------------- DEFINITIONS ----------------------------------------
+<object_classes>
+<object name='currency'>
+	<property name='code' mandatory='Y' is_key='Y' />
+	<property name='description'/>
+	<property name='exchange_rate' mandatory='Y' />
+	<property name='is_designated'/>
+	<relation name='currency_group' relation_object='currency_group' relation_type='unique'/>
+</object>
+<object name='currency_group'>
+	<property name='code' mandatory='Y' is_key='Y'/>
+	<property name='description'/>
+	<property name='is_commodity'/>
+</object>
+</object_classes>
+
+---------------------------------------- DATA ----------------------------------------
+<object_instances>
+<currency code ='GBP' description='Great Britain Pound' exchange_rate='1.5' is_designated='false'>
+	<currency_group code='Europe' />
+</currency>
+<currency_group code='Europe' description='European countries' is_commodity='false'/>
+</object_instances>

data/samples/simple_object.yaml

@@ -0,0 +1,21 @@
+# This format has multiple YAML streams: 
+# The first contains version info, date and author etc.
+# The subsequent are hashes, each being an entity with key the entity name
+# Note that strings are used as keys and not symbols for user clarity
+#
+version: 1.0.0
+date:    2012-10-13
+author:  Nick Townsend
+--- 
+currency:
+  code: GBP
+  description: Pounds Sterling
+  exchange_rate: 1.5
+  is_designated: false
+  currency_group: Europe
+---
+currency_group:
+  code: Europe
+  description: European Countries
+  is_commodity: false
+version: 1.0.1

data/samples/simple_object_seq.yaml

@@ -0,0 +1,18 @@
+# This format has two streams, the first version info etc.
+# The second is a sequence of hashes, each has being an entity
+#
+:version: 1.0.0
+--- 
+-
+  :currency:
+    :code: GBP
+    :description: Pounds Sterling
+    :exchange_rate: 1.5
+    :is_designated: false
+    :currency_group: Europe
+-
+  :currency_group:
+    :code: Europe
+    :description: European Countries
+    :is_commodity: false
+  :version: 1.0.1

data/samples/simple_object_sym.yaml

@@ -0,0 +1,19 @@
+# This format has multiple streams, the first version info etc.
+# The subsequent are hashes, each has being an entity
+# Symbols are used throughout
+#
+:version: 1.0.0
+:date:    2012-10-13
+--- 
+:currency:
+  :code: GBP
+  :description: Pounds Sterling
+  :exchange_rate: 1.5
+  :is_designated: false
+  :currency_group: Europe
+---
+  :currency_group:
+    :code: Europe
+    :description: European Countries
+    :is_commodity: false
+  :version: 1.0.1

data/spec/options_spec.rb

@@ -0,0 +1,31 @@
+require_relative '../lib/ditto/options'
+
+module Ditto
+  describe Options do
+    context "specifying no database" do
+      it "should return default" do
+	opts = Ditto::Options.new(["testfile"])
+	Ditto::Options::DEFAULT_CONNSTRING.should == opts.connstring
+      end
+    end
+    context "specifying a database" do
+      it "should return it" do
+	mydb = "username/password@//myserver:1521/my.service.com"
+	opts = Ditto::Options.new(["-d", "#{mydb}", "afile"])
+	opts.connstring.should == mydb
+      end
+    end
+    context "specifying files and no connection string" do
+      it "should return the files" do
+	opts = Ditto::Options.new(["file1", "file2"])
+	opts.files_to_load.should == ["file1", "file2"]
+      end
+    end
+    context "specifying files and a dictionary" do
+      it "should return the files" do
+	opts = Ditto::Options.new(["-d", "u/p@//serv:1521/mydb", "file1", "file2"])
+	opts.files_to_load.should == ["file1", "file2"]
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: ditto
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nick Townsend
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-12 00:00:00.000000000 Z
+dependencies:
+- !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: ! 'Database Independent Test Objects (Ditto)
+
+
+  Ditto defines a simple DSL that allows test data to be expressed in a database independent
+  format. When the underlying tables are remapped the QA team don''t have to go and
+  change all the historical test cases.
+
+
+  There are two parts, both of them versioned:
+
+  1. The data declarations
+
+  2. The mappings to the underlying database
+
+
+  Idea is to replace an XML dialect with something simpler. See sample at simple_object.xml
+
+
+  Nick Townsend, Oct 2012
+
+'
+email: nick.townsend@mac.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/ditto
+- CHANGELOG
+- ditto.gemspec
+- features/create_entities.feature
+- features/load_entity.feature
+- features/step_definitions/definition_steps.rb
+- features/support/hooks.rb
+- lib/ditto/dsl.rb
+- lib/ditto/entity.rb
+- lib/ditto/options.rb
+- lib/ditto/runner.rb
+- lib/ditto.rb
+- rakefile
+- README
+- samples/simple_object.xml
+- samples/simple_object.yaml
+- samples/simple_object_seq.yaml
+- samples/simple_object_sym.yaml
+- spec/options_spec.rb
+homepage: http://rubygems.org/gems/ditto
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Database independent test objects
+test_files: []