spectifly 0.0.1 → 0.0.2

data/README.md

@@ -48,23 +48,24 @@ Widget:
 
     Awesome?:
       Description: Whether or not the widget is awesome
+
   Related Entities:
     Belongs To:
       Manufacturing Plant*:
         Description: The WidgetCo location that constructed the widget
         Type: Manufacturing Location
+
     Has Many:
       Accessories:
-        Description: Widget Add-ons that augment the widget's
-functionality
+        Description: Widget Add-ons that augment the widget's functionality
         Type: Add On
 ```
 
 The root node, `Widget:` above, is required, and there can be only one node at
 this level.
 
-Directly below the root node, the only valid nodes are `Description` and
-`Fields`.  The `Description` is a plain language description of the entity.  The `Related Entities` node includes associations to other entities, grouped by how the entity is related.
+Directly below the root node, the only valid nodes are `Description` (optional),
+`Fields` (required), and `Related Entities` (optional).  The `Description` is a plain language description of the entity.  The `Related Entities` node includes associations to other entities, grouped by how the entity is related.
 
 ### Fields
 
@@ -102,22 +103,17 @@ If the `?` shortcut conflicts with the explicit key (e.g. a `Rad?` field with
 
 ### Related Entities
 
-`Related Entities`, is a YAML tree that enumerates the entities with which the defined entity are associated.  They are grouped by type of relationship and include the name of the association and which type of entity that association links to.  Like `Fields`, the `*` special token can be used to mark an entity as required.
+`Related Entities` is a YAML tree that enumerates the entities with which the defined entity is associated.  They are grouped by type of relationship and include the name of the association and which type of entity that association links to.  Like `Fields`, the `*` special token can be used to mark an association as required.  If a plural association (such as has_many or has_and_belongs_to_many) is marked as required, that relationship must have *at least one* member.
 
-* `Belongs To` is fairly straight-forward, i.e. a kitten belongs to a
-  litter of kittens
+* `Belongs To` is a singular association, where the owner is the other entity (e.g. a kitten belongs to a litter of kittens)
 
-* `Has One` also self-explanatory, i.e. a website user has one (and only
-  one) profile -- an inverse of `Belongs To`
+* `Has One` is a singular association, where the owner is this entity (e.g. a kitten has one (and only one) nose) -- an inverse of `Belongs To`
 
-* `Has Many` also an inverse of `Belongs To`, but 1 or more
+* `Has Many` is a plural association, where the owner is this entity (e.g. a kitten has many toys) -- also can be an inverse of `Belongs To`
 
-* `Has and Belongs To Many` is a many-to-many relationship between two
-  entities, such as a dish being made up of many ingredients and an
-ingredient being part of many dishes
+* `Has and Belongs To Many` is a many-to-many relationship between two entities, and plural on both sides (e.g. a dish is made up of many ingredients, and an ingredient is a component of many dishes)
 
-Under each of these Association nodes the YAML tree lists entities that relate to
-the described entity in that way.
+Under each of these association nodes, the YAML tree lists entities that relate to the described entity in that way.
 
 ## Contributing
 

data/Rakefile

@@ -1,8 +1,7 @@
 require "bundler/gem_tasks"
-require 'spectifly/tasks'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-task :default => :spec
+task :default => :spec

data/lib/spectifly/configuration.rb

@@ -1,8 +1,9 @@
 module Spectifly
   class Configuration
+    attr_accessor :entity_path
     def initialize(config = {})
-      @entity_path = config.fetch(:entity_path)
-      @presenter_path = config[:presenter_path]
+      @entity_path = config.fetch('entity_path')
+      @presenter_path = config['presenter_path']
     end
 
     def presenter_path

data/lib/spectifly/tasks.rb

@@ -1,15 +1,22 @@
 require 'rake'
 require 'rake/tasklib'
+require 'yaml'
+require 'spectifly/configuration'
 
 module Spectifly
   class Task < ::Rake::TaskLib
-    attr_accessor :config_path
+    attr_accessor :configuration
+
+    def configure!
+      config_path = File.join(Rake.original_dir, 'config', 'spectifly.yml')
+      config_hash = File.exist?(config_path) ? YAML.load_file(config_path) : {}
+      @configuration = Spectifly::Configuration.new(config_hash)
+    end
 
     def initialize(task_name, *args, &block)
-      @stuff = 'default stuff'
+      configure!
       task task_name, *args do |task_name, task_args|
-        block.call(self) if block
-        puts "This is #{task_name} task with #{config_path}"
+        block.call(configuration, task_args) if block
       end
     end
   end

data/lib/spectifly/version.rb

@@ -1,3 +1,3 @@
 module Spectifly
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/tasks/spectifly.rake

@@ -1,6 +1,22 @@
 namespace :spectifly do
-  desc 'Do whatever'
-  Spectifly::Task.new('whatever') do |sfly|
-    sfly.config_path = File.join(Rake.original_dir, 'config', 'spectifly.yml')
+  namespace :xsd do
+    Spectifly::Task.new('generate_from_entities', [:destination_path]) do |spectifly, args|
+      options = File.exist?(spectifly.presenter_path) ? { :presenter_path => spectifly.presenter_path } : {}
+
+      Spectifly::Entity.from_directory(spectifly.entity_path, options).each do |name, entity|
+        File.open(File.join(args[:destination_path], "#{name}.xsd"), 'w') do |f|
+          f.write Spectifly::Xsd::Builder.new(entity).build
+        end
+      end
+    end
+
+    Spectifly::Task.new('generate_extended_types', [:destination_path]) do |spectifly, args|
+      File.open(File.join(args[:destination_path], "extended.xsd"), 'w') do |f|
+        f.write Spectifly::Xsd::Types.build_extended
+      end
+    end
+
+    desc 'Generate all XSDs for the configured entity directory, including extended type definitions'
+    task :generate_all, [:destination_path] => [:generate_from_entities, :generate_extended_types]
   end
-end
+end

data/spec/spectifly/configuration_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Spectifly::Configuration do
   let(:configuration_args) {
     {
-      :entity_path => base_fixture_path
+      'entity_path' => base_fixture_path
     }
   }
   describe '.initialize' do
@@ -12,7 +12,7 @@ describe Spectifly::Configuration do
     end
 
     it 'fails if no entity path provided' do
-      configuration_args.delete(:entity_path)
+      configuration_args.delete('entity_path')
       expect { described_class.new(configuration_args) }.to raise_error
     end
   end
@@ -20,14 +20,14 @@ describe Spectifly::Configuration do
   describe '#presenter_path' do
     it 'returns configured value if set' do
       configuration = described_class.new(
-        configuration_args.merge(:presenter_path => 'goose')
+        configuration_args.merge('presenter_path' => 'goose')
       )
       configuration.presenter_path.should == 'goose'
     end
 
     it 'returns nil if no presenter path exists at entity path' do
       configuration = described_class.new(
-        configuration_args.merge(:entity_path => spec_path)
+        configuration_args.merge('entity_path' => spec_path)
       )
       configuration.presenter_path.should be_nil
     end
@@ -39,4 +39,4 @@ describe Spectifly::Configuration do
       configuration.presenter_path.should == base_presenter_path
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spectifly
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-17 00:00:00.000000000 Z
+date: 2013-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder