factory_girl_json 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in factory_girl_json.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Nikos Gereoudakis
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,128 @@
+# FactoryGirlJson
+
+This gem facilitates the creation of JSON fixtures for javascript testing in ruby apps.
+While testing composite views in front end "MVC" frameworks (Backbone, Emder, Angular etc) 
+you might need to create some quite complicated json fixtures to seed the models for the tests.
+
+This gem will use your `FactoryGirl` factories to create these json fixtures for you.
+
+Furthermore it supports custom serializers (e.g. [active_model_serializers](https://github.com/josevalim/active_model_serializers) or any class that takes a model in its constructor and responds to `to_json`).
+
+The fixtures can be loaded in your tests using a javascript library such as [jasmine-jquery](https://github.com/velesin/jasmine-jquery#json-fixtures).
+
+## Installation
+
+The gem has been used only in a Rails project in combination with `factory_girl_rails` but it should work with `factory_girl` gem as well.
+
+Add these lines to your application's Gemfile:
+    
+    group :test do
+      gem 'factory_girl_rails'
+      gem 'factory_girl_json'
+    end
+
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install factory_girl_json
+
+## Usage
+
+First, define some factories with factory girl. 
+You can add another option `json_serializer` which indicates which class will be used for the serialization of the model.
+
+    FactoryGirl.define do
+      factory :user do
+        sequence(:name) {|n| "user name #{n}"}
+        sequence(:email) {|n| "useremail#{n}@email.com"}
+        age 12
+      end
+
+      factory :user_with_posts, parent: :user, json_serializer: UserSerializer do
+        after(:create) do |user|
+          create :post, user: user
+        end
+      end
+    end
+
+
+    class UserSerializer
+      def initialize(user)
+        @user = user
+      end
+
+      def to_json(options = {})
+        posts = {posts: @user.posts.as_json}
+        user = @user.as_json
+        user['user'].merge! posts
+        JSON.generate user
+      end
+    end
+
+
+Now if you run this command
+
+`RAILS_ENV=test bundle exec rake factory_girl_json:export['user']`
+
+you will get a `user.json` file with data:
+
+    {
+      "user": {
+        "age": 12,
+        "email": "useremail1@email.com",
+        "id": 1,
+        "name": "user name 1"
+      }
+    }
+
+`RAILS_ENV=test bundle exec rake factory_girl_json:export['user_with_posts']`
+
+you will get a `user_with_posts.json` file with data:
+
+    {
+      "user": {
+        "age": 12,
+        "email": "useremail1@email.com",
+        "id": 1,
+        "name": "user name 1",
+        "posts": [
+          {
+            "post": {
+              "body": "post body",
+              "id": 1,
+              "title": "post title",
+              "user_id": 1
+            }
+          }
+        ]
+      }
+    }
+
+### All rake tasks
+    rake factory_girl_json:all                        # Exports json fixtures for all FactoryGirl factories
+    rake factory_girl_json:export[factory_name]       # Exports json fixture for the selected FactoryGirl factory
+    rake factory_girl_json:export_serialized          # Exports json fixtures for FactoryGirl factories with the json_serializer option
+
+### Default exporting paths
+if Rails is used it will write the json files to `spec\javascripts\fixtures\json` or `test\javascripts\fixtures\json`
+otherwise it uses the current path.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Related projects
+
+[Backbone-Factory](https://github.com/SupportBee/Backbone-Factory)
+
+## Author
+
+[Nikos Gereoudakis](https://twitter.com/ni_ger)

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+

data/factory_girl_json.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/factory_girl_json/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Nikos Gereoudakis"]
+  gem.email         = ["gereoudakis@gmail.com"]
+  gem.description   = %q{Create json fixtures from your FactoryGirl factories}
+  gem.summary       = %q{Create json fixtures from your FactoryGirl factories}
+  gem.homepage      = "https://github.com/stream7/factory_girl_json"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "factory_girl_json"
+  gem.require_paths = ["lib"]
+  gem.version       = FactoryGirlJson::VERSION
+  
+  gem.add_dependency "factory_girl"
+  gem.add_dependency "json"
+  gem.add_dependency "database_cleaner"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "activerecord"
+  gem.add_development_dependency "sqlite3"
+end

data/lib/factory_girl_json.rb

@@ -0,0 +1,33 @@
+require 'factory_girl'
+require 'fileutils'
+require 'database_cleaner'
+require 'factory_girl_json/factory_girl_ext/valid_options'
+require 'factory_girl_json/version'
+require 'factory_girl_json/exporter'
+require 'factory_girl_json/railtie' if defined? Rails
+
+module FactoryGirlJson
+  class << self
+    
+    def export(factory_name)
+      clean
+      Exporter.new(factory_name).export
+    end
+
+    def export_all
+      clean
+      Exporter.new(:all).export
+    end
+
+    def export_serialized
+      clean
+      Exporter.new(:serialized).export
+    end
+
+    def clean
+      DatabaseCleaner.clean_with :truncation
+      DatabaseCleaner.clean
+    end
+
+  end
+end

data/lib/factory_girl_json/exporter.rb

@@ -0,0 +1,73 @@
+module FactoryGirlJson
+  class Exporter
+    def initialize(factories)
+      @factories = find_factories(factories)
+      $stdout.puts "Exporting factories: #{@factories.map(&:name)}"
+    end
+
+    def export
+      @factories.each do |factory|
+        export_factory(factory)
+      end
+    end
+
+    def export_factory(factory)
+      $stdout.puts "Exporting factory #{factory.name}"
+      path = file_path(factory)
+      unless File.exists? path
+        model = factory.run(:create, {})
+        json = to_json(model, factory.json_serializer)
+        write_file(json, path)
+      else
+        $stderr.puts "File #{factory.name}.json exists, delete file and run again to rewrite"
+      end
+    end
+
+    def to_json(model, serializer = nil)
+      if serializer
+        serializer.new(model).to_json
+      else
+        model.to_json
+      end
+    end
+
+    def write_file(json, path)
+      FileUtils.mkdir_p File.dirname(path)
+      File.open(path, 'w') do |file|  
+        file.puts JSON.pretty_generate(JSON.parse(json))
+      end
+      $stdout.puts "Wrote file #{path}"
+    end
+
+    def file_path(factory)
+      if defined? Rails
+        if Dir.exists? Rails.root.join('spec').to_s
+          Rails.root.join("spec/javascripts/fixtures/json/#{factory.name}.json").to_s
+        elsif Dir.exists? Rails.root.join('test').to_s
+          Rails.root.join("test/javascripts/fixtures/json/#{factory.name}.json").to_s
+        else
+          "#{Dir.pwd}/#{factory.name}.json"  
+        end
+      else
+        "#{Dir.pwd}/#{factory.name}.json"
+      end
+    end
+
+    private 
+
+    def find_factories(factories)
+      case factories
+      when :all
+        FactoryGirl.factories.to_a
+      when :serialized
+        FactoryGirl.factories.to_a.select { |f| f.json_serializer }
+      else
+        if factories.is_a? Array
+          FactoryGirl.factories.to_a.select { |f| factories.include? f.name.to_s }
+        else
+          [FactoryGirl.factories.find(factories.to_sym)]
+        end
+      end
+    end
+  end
+end

data/lib/factory_girl_json/factory_girl_ext/valid_options.rb

@@ -0,0 +1,12 @@
+module FactoryGirl
+  class Factory
+    attr_reader :json_serializer
+
+    private
+
+    def assert_valid_options(options)
+      options.assert_valid_keys(:class, :parent, :aliases, :traits, :json_serializer)
+      @json_serializer = options[:json_serializer]
+    end
+  end
+end

data/lib/factory_girl_json/railtie.rb

@@ -0,0 +1,7 @@
+module FactoryGirlJson
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'tasks/factory_girl_json.rake'
+    end
+  end
+end

data/lib/factory_girl_json/version.rb

@@ -0,0 +1,3 @@
+module FactoryGirlJson
+  VERSION = "0.0.1"
+end

data/lib/tasks/factory_girl_json.rake

@@ -0,0 +1,18 @@
+namespace :factory_girl_json do
+
+  desc 'Exports json fixtures for all FactoryGirl factories'
+  task :all => :environment do
+    FactoryGirlJson.export_all
+  end
+  
+  desc 'Exports json fixture for the selected FactoryGirl factory'
+  task :export, [:factory_name] => :environment do |t, args|
+    FactoryGirlJson.export args[:factory_name]
+  end
+
+  desc 'Exports json fixtures for FactoryGirl factories with the json_serializer option'
+  task :export_serialized => :environment do
+    FactoryGirlJson.export_serialized
+  end
+end
+

data/spec/factories/posts.rb

@@ -0,0 +1,7 @@
+FactoryGirl.define do
+  factory :post do
+    user
+    title 'post title'
+    body 'post body'
+  end
+end

data/spec/factories/users.rb

@@ -0,0 +1,13 @@
+FactoryGirl.define do
+  factory :user do
+    sequence(:name) {|n| "user name #{n}"}
+    sequence(:email) {|n| "useremail#{n}@email.com"}
+    age 12
+  end
+
+  factory :user_with_posts, parent: :user, json_serializer: UserSerializer do
+    after(:create) do |user|
+      create :post, user: user
+    end
+  end
+end

data/spec/factory_girl_json_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe FactoryGirlJson do 
+  it "should genarate a file" do
+    FactoryGirlJson.export('user')
+    path = "#{Dir.pwd}/user.json"
+    File.exists?(path).should be_true
+    File.delete path
+  end
+  
+  it "should genarate a file with user json" do
+    FactoryGirlJson.export('user')
+    path = "#{Dir.pwd}/user.json"
+    File.exists?(path).should be_true
+    hash = JSON.parse(File.read(path))
+    user = hash['user']
+    user['id'].should_not be_nil
+    user['name'].should_not be_nil
+    user['email'].should_not be_nil
+    user['age'].should_not be_nil
+    File.delete path
+  end
+
+  it "should use json_serializer if present" do
+    FactoryGirlJson.export('user_with_posts')
+    path = "#{Dir.pwd}/user_with_posts.json"
+    File.exists?(path).should be_true
+    hash = JSON.parse(File.read(path))
+    user = hash['user']
+    user['id'].should_not be_nil
+    user['name'].should_not be_nil
+    user['email'].should_not be_nil
+    user['age'].should_not be_nil
+    user['posts'].should_not be_nil
+    user['posts'][0]['post']['title'].should_not be_nil
+    File.delete path
+  end
+
+
+  describe ".export_all" do
+    it "should export three files" do
+      FactoryGirlJson.export_all  
+      Dir['*.json'].size.should eq(3)
+      Dir['*.json'].each {|f| File.delete(f) }
+    end
+  end
+
+
+  describe ".export_serialized" do
+    it "should export three files" do
+      FactoryGirlJson.export_serialized  
+      Dir['*.json'].size.should eq(1)
+      Dir['*.json'].first.should eq('user_with_posts.json')
+      Dir['*.json'].each {|f| File.delete(f) }
+    end
+  end
+
+end

data/spec/models/post.rb

@@ -0,0 +1,3 @@
+class Post < ActiveRecord::Base
+  belongs_to :user
+end

data/spec/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  has_many :posts
+end

data/spec/serializers/user_serializer.rb

@@ -0,0 +1,12 @@
+class UserSerializer
+  def initialize(user)
+    @user = user
+  end
+
+  def to_json(options = {})
+    posts = {posts: @user.posts.as_json}
+    user = @user.as_json
+    user['user'].merge! posts
+    JSON.generate user
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'factory_girl_json'
+require 'active_record'
+require 'models/user'
+require 'models/post'
+require 'serializers/user_serializer'
+require 'factories/posts'
+require 'factories/users'
+
+ActiveRecord::Base.establish_connection(
+  :adapter => 'sqlite3',
+  :database => ':memory:'
+)
+
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :users, :force => true do |t|
+    t.string :name
+    t.string :email
+    t.integer :age
+  end
+
+  create_table :posts, :force => true do |t|
+    t.integer :user_id
+    t.string :title
+    t.text :body
+  end
+
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: factory_girl_json
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nikos Gereoudakis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: Create json fixtures from your FactoryGirl factories
+email:
+- gereoudakis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- factory_girl_json.gemspec
+- lib/factory_girl_json.rb
+- lib/factory_girl_json/exporter.rb
+- lib/factory_girl_json/factory_girl_ext/valid_options.rb
+- lib/factory_girl_json/railtie.rb
+- lib/factory_girl_json/version.rb
+- lib/tasks/factory_girl_json.rake
+- spec/factories/posts.rb
+- spec/factories/users.rb
+- spec/factory_girl_json_spec.rb
+- spec/models/post.rb
+- spec/models/user.rb
+- spec/serializers/user_serializer.rb
+- spec/spec_helper.rb
+homepage: https://github.com/stream7/factory_girl_json
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+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: Create json fixtures from your FactoryGirl factories
+test_files:
+- spec/factories/posts.rb
+- spec/factories/users.rb
+- spec/factory_girl_json_spec.rb
+- spec/models/post.rb
+- spec/models/user.rb
+- spec/serializers/user_serializer.rb
+- spec/spec_helper.rb