falcor 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NzhjNWU1YTY3NzA0OWRiZDk2NDZmZTRlZTQ2NGQ1OTE2YTc3NDE4YQ==
-  data.tar.gz: !binary |-
-    MmU5ZWUzMTYxM2Y1MzgxMDI2ZDc1NjM4NzJmMWEzY2RkYjc5MjY5MQ==
+SHA1:
+  metadata.gz: 5c555733f4c7649530fcb7e375c404ee2f8e03fa
+  data.tar.gz: a338aa2d1cce1bf75832f356762abdeab7a9d7bc
 SHA512:
-  metadata.gz: !binary |-
-    YzNkYzkxZjdjYjhlODVmNzc0Y2E0ZTYzNGE3NmZiNWQ4NDliZjUwNDkzNjBm
-    NzZiZjQxOGJhYWZlMWNjYTdmNjI4OGEzYmRmNDcxOTQ3OTIzNWFkMTMwODZj
-    YTBjYTkzOGU4MjdhOWJiMWFhNWI4Mzk4NjllMGZkOTUyYjgwNDM=
-  data.tar.gz: !binary |-
-    MTRhNTMwMjYyZDdmYTcxNjZlNDIxNDgwNzg2NTY3Yzk3NjdkNDAyZGQwMjU5
-    ZmNlMGUzN2YyMzQzNTk1YTQ5NGQ3Njk3MDJiYWZhN2JmYTg4Yzc1ZmM2MmZi
-    MmRiNmJjMjg2YWNiNjRjZWI3NDM5YzU3ODMwYzljNTgyODg5MDc=
+  metadata.gz: 651195049a51fbb1461457f585e51fdb86a2748feea4a92582f2642c3e7587189f855a038611e1c22564539996c2917b5c415b47b5394e743cb1870e259d0150
+  data.tar.gz: 4ca3b1990de719dd0fcb95d0ff0e5872d373bb709f441e54aea7d44611e76f480d76482451421cafc0386ca6e8235f44b61568883a29b71dfeda725b11f11849

data/.gitignore

@@ -15,3 +15,6 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+
+.ruby-version
+.ruby-gemset

data/README.md

@@ -26,7 +26,9 @@ Or install it yourself as:
 
 ## Usage
 
-Here's how you'd define some factories, create an instance of the new `user` factory, and then turn it into JSON:
+### Defining factories & creating instances
+
+Here's how you'd define some factories, create an instance of the new `user` factory, and then turn it into a hash to use as JSON:
 
 ```ruby
 Falcor::Fabricator.define :blog_post do
@@ -44,23 +46,58 @@ end
 user = Factory :user
 
 user.to_json
-#=> {:email=>"user@example.com",
- :full_name=>"Matt Gauger",
- :blog_posts=>
-  [{:title=>"My post", :body=>"Lots of text"},
-   {:title=>"My post", :body=>"Lots of text"}]}
+
+=> {"email"=>"user@example.com",
+ "full_name"=>"Matt Gauger",
+ "blog_posts"=>
+  [{"title"=>"My post", "body"=>"Lots of text"},
+   {"title"=>"My post", "body"=>"Lots of text"}]}
 ```
 
+### Overriding defaults
+
 You can also override defaults:
 
 ```ruby
 post = Factory :blog_post, title: "My really cool post"
 
 post.title
-#=> "My really cool blog post"
+=> "My really cool blog post"
+```
+
+### Optional fields
+
+For optional fields on factories (those that don't have a default value and shouldn't show up in JSON unless set), use `allow`:
+
+```ruby
+Falcor::Fabricator.define :contact do
+  allow :full_name
+  allow :phone_number
+  allow :address
+end
+
+contact = Factory :contact, full_name: "Robert Pitts"
+
+contact.to_json
+=> {"full_name"=>"Robert Pitts"} # Other attributes don't appear in JSON
 ```
 
-And much more! (To be continued...)
+### Associations
+
+The most basic form of association assumes that the name of the attribute matches the Factory of the assocation:
+
+```ruby
+Falcor::Fabricator.define :metadata do
+  field :api_version, "2.1"
+  field :stub_data, false
+end
+
+Falcor::Fabricator.define :report do
+  field :name, "Simple Report"
+  field :answer, 42
+  association :metadata
+end
+```
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,6 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/falcor.gemspec

@@ -4,24 +4,25 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'falcor/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "falcor"
+  spec.name          = 'falcor'
   spec.version       = Falcor::VERSION
-  spec.authors       = ["Matt Gauger"]
-  spec.email         = ["matt.gauger@gmail.com"]
-  spec.description   = "Quickly build example data"
-  spec.summary       = "Quickly build example data"
-  spec.homepage      = "https://github.com/mathias/falcor"
-  spec.license       = "MIT"
+  spec.authors       = ['Matt Gauger']
+  spec.email         = ['matt.gauger@gmail.com']
+  spec.description   = 'Quickly build example data'
+  spec.summary       = 'Quickly build example data'
+  spec.homepage      = 'https://github.com/mathias/falcor'
+  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.require_paths = ['lib']
 
   spec.add_dependency 'activesupport',  '~> 4.0.0'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "pry-debugger"
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-debugger'
+  spec.add_development_dependency 'rspec'
 end

data/lib/falcor/define_dsl.rb

@@ -33,9 +33,13 @@ module Falcor
         self.send(:define_method, "#{attr}=", default_assignment_blk)
       end
 
-      def association(attr, model)
+      def association(attr, model=nil)
         self.associations = (self.associations || []).push(attr)
 
+        unless model
+          model = Factory attr
+        end
+
         default_blk = Proc.new { return self.instance_variable_get("@#{attr}".to_sym) || model }
         self.send(:define_method, attr, default_blk)
 

data/lib/falcor/fabricator.rb

@@ -5,7 +5,7 @@ module Falcor
     class << self
       attr_accessor :factories
 
-      def define(name, options = {}, &block)
+      def define(name, options={}, &block)
         factories[name] = self.new({ :name => name, :block => block }.merge(options))
       end
 

data/lib/falcor/factory.rb

@@ -39,16 +39,16 @@ module Falcor
       fields.each do |field|
         value = self.send(field)
         unless value.nil?
-          json[field] = self.send(field)
+          json[field.to_s] = self.send(field)
         end
       end
 
       associations.each do |field|
-        json[field] = self.send(field).send(:to_json)
+        json[field.to_js] = self.send(field).send(:to_json)
       end
 
       lists.each do |field|
-        json[field] = self.send(field).map { |m| m.to_json }
+        json[field.to_s] = self.send(field).map { |m| m.to_json }
       end
 
       json

data/lib/falcor/version.rb

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

data/spec/fabricator_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Falcor::Fabricator do
+  describe '.define' do
+    it 'can define basic factories' do
+      Falcor::Fabricator.define :xyzzy do
+        field :foo, "bar"
+        field :baz, "quux"
+      end
+
+      expect(Falcor::Fabricator.factories).to have_key(:xyzzy)
+    end
+  end
+end

data/spec/factory_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe 'Factory' do
+  context 'basic factory functionality' do
+    before do
+      Falcor::Fabricator.define :blog_post do
+        field :title, "My post"
+        field :body, "Lots of text"
+      end
+    end
+
+    it 'can create a basic factory with default attributes' do
+      post = Factory :blog_post
+      expect(post.title).to eq "My post"
+      expect(post.body).to eq "Lots of text"
+    end
+
+    it 'generates the expected hash for JSON' do
+      post = Factory :blog_post
+      expect(post.to_json).to eq({ "title" => "My post", "body" => "Lots of text" })
+    end
+
+    it 'allows attributes to be overridden' do
+      post = Factory :blog_post, title: "My super sweet post"
+      expect(post.title).to eq "My super sweet post"
+    end
+  end
+
+  context 'factory associations' do
+    before do
+      Falcor::Fabricator.define :author do
+        field :username, "matt@example.com"
+        field :password, "password"
+      end
+
+      Falcor::Fabricator.define :blog_post do
+        field :title, "My post"
+        field :body, "Lots of text"
+        association :author
+      end
+    end
+
+    it 'can create associations that default to the factory named by the attribute' do
+      post = Factory :blog_post
+      expect(post.author.username).to eq "matt@example.com"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'falcor'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: falcor
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Matt Gauger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-02 00:00:00.000000000 Z
+date: 2013-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -42,42 +42,56 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-debugger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Quickly build example data
@@ -99,6 +113,9 @@ files:
 - lib/falcor/fabricator.rb
 - lib/falcor/factory.rb
 - lib/falcor/version.rb
+- spec/fabricator_spec.rb
+- spec/factory_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/mathias/falcor
 licenses:
 - MIT
@@ -109,18 +126,21 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.9
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: Quickly build example data
-test_files: []
+test_files:
+- spec/fabricator_spec.rb
+- spec/factory_spec.rb
+- spec/spec_helper.rb