spectifly-sequel 0.0.1

data/spec/expectations/animal_multiple_value_string_field.migration

@@ -0,0 +1,8 @@
+
+    create_table(:individuals_animals) do
+      primary_key :id
+      foreign_key :individual_id, :individuals, :null => false
+      String :name, :null => false
+    end
+
+    add_index [:individual_id, :name], :individuals_animals, :unique => true

data/spec/expectations/cow.migration

@@ -0,0 +1,19 @@
+Sequel.migration do
+  change do
+    create_table(:kine) do
+      primary_key :id
+      String :name, :null => false
+      Integer :age
+      Numeric :cost, :null => false
+      String :color
+      foreign_key :owner_id, :individuals
+    end
+
+    create_table(:calves_kine) do
+      foreign_key :cow_id, :kine, :null => false
+      foreign_key :calf_id, :kine, :null => false
+    end
+
+    add_index [:cow_id, :calf_id], :calves_kine, :unique => true
+  end
+end

data/spec/expectations/group.migration

@@ -0,0 +1,10 @@
+Sequel.migration do
+  change do
+    create_table(:groups) do
+      primary_key :id
+      String :name, :null => false, :unique => true
+      Boolean :associated_organization
+      foreign_key :leader_id, :individuals
+    end
+  end
+end

data/spec/expectations/individual.migration

@@ -0,0 +1,21 @@
+Sequel.migration do
+  change do
+    create_table(:individuals) do
+      primary_key :id
+      String :name, :null => false
+      String :ssn, :null => false, :unique => true
+      Integer :age
+      Boolean :happy
+      DateTime :created_at
+      foreign_key :group_id, :groups, :null => false
+    end
+
+    create_table(:individuals_favorites) do
+      primary_key :id
+      foreign_key :individual_id, :individuals, :null => false
+      String :name, :null => false
+    end
+
+    add_index [:individual_id, :name], :individuals_favorites, :unique => true
+  end
+end

data/spec/fixtures/config_file.yml

@@ -0,0 +1,7 @@
+Spectifly: &default
+  entity_definition_path: ./spec/fixtures/
+  Sequel:
+    <<: *default
+    migration_path: ./spec/tmp/migrations/
+    migration_version_type: Integer
+

data/spec/fixtures/cow.entity

@@ -0,0 +1,34 @@
+Cow:
+  Fields:
+    Name*:
+      Description: My Cow's name
+
+    Age:
+      Type: Integer
+
+    Cost*:
+      Type: Currency
+
+    Color:
+      Valid values:
+        - Brown
+        - Black
+        - Grey
+        - White
+        - Other
+
+  Related Entities:
+    Has Many:
+      Calves:
+        Description: Baby cow
+        Type: Cow
+
+    Belongs To Many:
+      Cow*:
+        Description: Parent cows
+        Type: Cow
+
+    Belongs To:
+      Owner:
+        Type: Individual
+

data/spec/fixtures/group.entity

@@ -0,0 +1,17 @@
+Group:
+  Fields:
+    Name*:
+      Description: A thing
+      Validations: must be unique
+
+    Associated Organization?:
+      Description: Is this an organized group or is it hodge-podge?
+
+  Related Entities:
+    Has Many:
+      Individuals:
+        Type: Individual
+
+    Has One:
+      Leader:
+        Type: Individual

data/spec/fixtures/individual.entity

@@ -0,0 +1,37 @@
+Individual:
+  Description: Person-y thing
+  Fields:
+    Name*:
+      Description: The thing you call the person
+
+    Ssn*:
+      Description: We're assuming individuals are US citizens, I guess.
+      Unique: true
+
+    Age:
+      Type: Integer
+
+    Happy?:
+      Description: Is the individual happy?
+
+    Created At:
+      Type: DateTime
+
+    Favorites:
+      Description: Random things the individual likes
+      Multiple: true
+      Valid Values:
+        - Strawberries
+        - Monkeys
+        - Dogma
+        - Creationism
+
+  Related Entities:
+    Belongs To:
+      Group*:
+        Type: Group
+
+    Has Many:
+      Cows:
+        Description: Cows owned by an individual
+        Type: Cow

data/spec/fixtures/invalid_config_file.yml

@@ -0,0 +1,2 @@
+entity_definition_path: ./
+migration_path: ../tmp/migrations/

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'spectifly'
+require_relative '../lib/spectifly/sequel'
+
+def spec_path
+  File.dirname(__FILE__)
+end
+
+def migration_output_path
+  File.join(spec_path, 'tmp', 'migrations')
+end
+
+def base_expectation_path
+  File.join(spec_path, 'expectations')
+end
+
+def expectation_path(expectation)
+  File.join(base_expectation_path, "#{expectation}.migration")
+end
+
+def base_fixture_path
+  File.join(spec_path, 'fixtures')
+end
+
+def fixture_path(fixture)
+  File.join(base_fixture_path, "#{fixture}.entity")
+end

data/spec/spectifly/sequel/builder_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'json'
+
+describe Spectifly::Sequel::Builder do
+  describe '.build' do
+    it 'works for a simple case' do
+      path_builder = Spectifly::Sequel::Builder.from_path(fixture_path('group'))
+      migration_path = expectation_path('group')
+      migration = path_builder.build
+      migration.should == File.read(migration_path)
+    end
+
+    it 'works for simple, multiple simple value associations' do
+      path_builder = Spectifly::Sequel::Builder.from_path(fixture_path('individual'))
+      migration_path = expectation_path('individual')
+      migration = path_builder.build
+      migration.should == File.read(migration_path)
+    end
+
+    it 'works for many-to-many associations' do
+      path_builder = Spectifly::Sequel::Builder.from_path(fixture_path('cow'))
+      migration_path = expectation_path('cow')
+      migration = path_builder.build
+      migration.should == File.read(migration_path)
+    end
+  end
+end

data/spec/spectifly/sequel/config_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe Spectifly::Sequel do
+  let(:path_to_config_file) { File.join(base_fixture_path, 'config_file.yml') }
+  let(:path_to_invalid_config_file) { File.join(base_fixture_path, 'invalid_config_file.yml') }
+  let(:config_hash) {
+    {
+      'migration_path' => 'foo/bar/baz.yml',
+      'entity_definition_path' => 'blah/blah/',
+      'migration_version_type' => 'Timestamp',
+    }
+  }
+  let(:friendly_config_instructions) {
+<<-INSTRUCTIONS
+Please format config files in the following manner:
+``- begin YAML
+Sequel:
+  Spectifly:
+    migration_path: PATH_TO_MIGRATION_DIRECTORY
+    entity_definition_path: PATH_TO_ENTITY_DEFINITION_DIRECTORY
+``- end YAML
+INSTRUCTIONS
+  }
+
+  it 'should allow config to be read from yaml in a path specified by the user' do
+    described_class.configure_with path_to_config_file
+    described_class.migration_path.should == './spec/tmp/migrations/'
+    described_class.entity_definition_path.should == './spec/fixtures/'
+    described_class.migration_version_type.should == 'Integer'
+  end
+
+  it 'should accept a config in hash format' do
+    described_class.configure config_hash
+    described_class.migration_path.should == 'foo/bar/baz.yml'
+    described_class.entity_definition_path.should == 'blah/blah/'
+    described_class.migration_version_type.should == 'Timestamp'
+  end
+
+  it 'gives reasonable, instructive error if YAML is misconfigured' do
+    lambda {
+      described_class.configure_with path_to_invalid_config_file
+    }.should raise_error(friendly_config_instructions)
+  end
+
+  it 'gives reasonable, instructive error if either path is not set' do
+    described_class.configure({:migration_path => nil, :entity_definition_path => nil, :migration_version_type => 'IDoNotKnow'})
+    lambda {
+      described_class.migration_path
+    }.should raise_error('Spectify::Sequel is not configured properly. "migration_path" must be set via YAML or a hash.')
+    lambda {
+      described_class.entity_definition_path
+    }.should raise_error('Spectify::Sequel is not configured properly. "entity_definition_path" must be set via YAML or a hash.')
+    described_class.migration_version_type.should == 'Timestamp'
+  end
+
+  it 'defaults to Timestamp migration versions if not set' do
+    described_class.configure({:migration_version_type => nil})
+    described_class.migration_version_type.should == 'Timestamp'
+  end
+end

data/spec/spectifly/sequel/field_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+require_relative '../../../lib/spectifly/sequel/field'
+
+describe Spectifly::Sequel::Field do
+  describe '#type' do
+    it 'defaults to String if no type is given' do
+      field = described_class.new('I cannot spell rhubarb')
+      field.type.should == 'String'
+    end
+
+    it 'returns Boolean if field has ? token' do
+      field = described_class.new('Can I spell misspelled?')
+      field.type.should == 'Boolean'
+    end
+
+    it 'returns the base type of an extended type' do
+      field = described_class.new('OneMillionDollars', { 'Type' => 'Currency' })
+      field.type.should == 'Numeric'
+    end
+  end
+
+  describe 'uniqueness restriction' do
+    it 'unique should be false by default and there should be no unique restriction' do
+      field = described_class.new("Mini me")
+      field.should_not be_unique
+      field.restrictions.keys.should_not be_include('unique')
+    end
+
+    it 'adds a restriction and returns true for unique? if there is a uniqueness validation' do
+      field = described_class.new("Little Snowflake", {"Validations" => "must be unique"})
+      field.should be_unique
+      field.restrictions.keys.include?('unique').should be_true
+    end
+
+    it 'adds a restriction and returns true for unique? if there is an attribute Unique set to true' do
+      field = described_class.new("Little Snowflake", {"Unique" => "true"})
+      field.should be_unique
+      field.restrictions.keys.include?('unique').should be_true
+    end
+
+    it 'throws an error if the two ways of setting uniqueness contradict each other' do
+      lambda {
+      field = described_class.new("Little Snowflake?", {"Validations" => "must be unique", "Unique" => false})
+      }.should raise_error
+    end
+  end
+
+  describe '#for_new_migration' do
+    Model = Struct.new(:entity_name, :table_name, :name_as_foreign_key)
+    let(:individual_model) { Model.new('individual', 'individuals', 'individual_id') }
+    it 'returns a column definition with options for a required field' do
+      field = described_class.new('Why am I required*')
+      field.for_new_migration(individual_model).should == 'String :why_am_i_required, :null => false'
+    end
+
+    it 'returns a basic association table for a field with multiple native-type values' do
+      field = described_class.new('Animals',  {'Valid Values' => ['Giraffe', 'Puffin', 'Dog'], 'Multiple' => true})
+      field.for_new_migration(individual_model, []).should == File.read(expectation_path('animal_multiple_value_string_field'))
+    end
+  end
+end

data/spec/spectifly/sequel/migration_generator_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Spectifly::Sequel::MigrationGenerator do
+  before :each do
+    Spectifly::Sequel.configure_with File.join(base_fixture_path, 'config_file.yml')
+    cleanup_files
+  end
+
+  after :each do
+    cleanup_files
+  end
+
+  def cleanup_files
+    Dir.glob("#{migration_output_path}/*.rb") do |rb_file|
+      File.delete(rb_file)
+    end
+  end
+
+  it 'reads a Spectifly entity definition file and outputs a migration that can generate a new table for that entity' do
+    generator = Spectifly::Sequel::MigrationGenerator.new('individual')
+    generator.run!
+    expected_migration_path = File.join(migration_output_path, '001_create_individuals.rb')
+    File.should exist(expected_migration_path)
+    File.read(expected_migration_path).should == File.read(expectation_path('individual'))
+  end
+
+  it 'determines what the next migration version should be' do
+    File.open(File.join(migration_output_path, '001_create_cookies.rb'), 'w') { |f| f.write('Hi!') }
+
+    generator = Spectifly::Sequel::MigrationGenerator.new('individual')
+    generator.run!
+
+    expected_migration_path = File.join(migration_output_path, '002_create_individuals.rb')
+    File.should exist(expected_migration_path)
+  end
+
+  it 'uses current datetime if user is assigning timestamps' do
+    DateTime.stub(:now).and_return DateTime.new(2013,01,01)
+    generator = Spectifly::Sequel::MigrationGenerator.new('individual', migration_output_path, base_fixture_path, 'Timestamp')
+    generator.run!
+
+    expected_migration_path = File.join(migration_output_path, '20130101000000_create_individuals.rb')
+    File.should exist(expected_migration_path)
+  end
+end

data/spec/spectifly/sequel/model_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+require_relative '../../../lib/spectifly/sequel/model'
+
+describe Spectifly::Sequel::Model do
+  describe '#table_name' do
+    def model_for(entity_type)
+      entity = Spectifly::Entity.new(fixture_path(entity_type))
+      described_class.new(entity, [])
+    end
+
+    it 'pluralizes and tokenizes an entity\'s root' do
+      model_for('individual').table_name.should == 'individuals'
+      
+      model_for('cow').table_name.should == 'kine'
+    end
+  end
+end

data/spec/spectifly/sequel/types_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+require_relative '../../../lib/spectifly/sequel/types'
+
+describe Spectifly::Sequel::Types do
+  describe 'Native types' do
+    it 'includes String, DateTime, Integer, Numeric, etc' do
+      (%w(String DateTime Integer Numeric) - Spectifly::Sequel::Types::Native).should == []
+    end
+  end
+end

data/spec/tmp/migrations/README

@@ -0,0 +1,2 @@
+This is here in order to check in the directory structure.  Migrations
+generated from tests will end up here.

data/spectifly-sequel.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spectifly/sequel/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "spectifly-sequel"
+  spec.version       = Spectifly::Sequel::VERSION
+  spec.authors       = ["Maher Hawash","Ravi Gadad", "Laurie Kemmerer", "David Miller"]
+  spec.email         = ["mhawash@renewfund.com", "ravi@renewfund.com", "laurie@renewfund.com", "dave.miller@renewfund.com"]
+  spec.description   = %q{An add-on to the Spectifly gem that generates Sequel migrations andd models based on Spectifly}
+  spec.summary       = %q{A Sequel add-on to Spectifly https://github.com/renewablefunding/spectifly}
+  spec.homepage      = ""
+  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_runtime_dependency "spectifly"
+  spec.add_runtime_dependency "sequel"
+  spec.add_runtime_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "debugger"
+  spec.add_development_dependency "simplecov"
+end