json_schema_builder 0.0.3 → 0.0.4

data/README.rdoc

@@ -14,7 +14,7 @@ Hook the gem into your rails app and create the schema files.
 
   gem 'json_schema_builder'
 
-  schema build
+  rake schema:build
 
 Your Models and their fields are written into JSON files which you can
 pimp further.

data/bin/schema

@@ -6,12 +6,12 @@ require 'json_schema_builder'
 require 'gli'
 include GLI
 
-version JsonSchemaBuilder::VERSION
+version SchemaBuilder::VERSION
 
-desc "Creates schema file in current directory/json-schema/*.json"
+desc "Create schema files in json-schema/*.json"
 command :build do |c|
   c.action do |global_options, options, args|
-    builder = JsonSchemaBuilder::Writer.new
+    builder = SchemaBuilder::Writer.new
     builder.write
   end
 end

data/json_schema_builder.gemspec

@@ -1,15 +1,15 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "json_schema_builder/version"
+$:.push File.expand_path('../lib', __FILE__)
+require 'schema_builder/version'
 
 Gem::Specification.new do |s|
-  s.name        = "json_schema_builder"
-  s.version     = JsonSchemaBuilder::VERSION
-  s.authors     = ["Georg Leciejewski"]
-  s.email       = ["gl@salesking.eu"]
-  s.homepage    = "http://www.salesking.eu"
-  s.summary     = %q{Build JSON Schema fields for ActiveRecord models}
-  s.description = %q{Build JSON Schema fields for ActiveRecord models}
+  s.name        = 'json_schema_builder'
+  s.version     = SchemaBuilder::VERSION
+  s.authors     = ['Georg Leciejewski']
+  s.email       = ['gl@salesking.eu']
+  s.homepage    = 'http://www.salesking.eu/dev'
+  s.summary     = %q{A good API needs JSON Schema description! Get it right and build JSON Schemata for your ActiveRecord models}
+  s.description = %q{The first step to a clean and simple API is a unified API description in form of a shared JSON Schema}
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/json_schema_builder.rb

@@ -1,5 +1 @@
-require 'json'
-require 'json_schema_builder/version'
-require 'json_schema_builder/writer'
-
-module JsonSchemaBuilder;end
+require 'schema_builder'

data/lib/schema_builder/railtie.rb

@@ -0,0 +1,7 @@
+module SchemaBuilder
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      require "schema_builder/tasks"
+    end
+  end
+end

data/lib/schema_builder/tasks.rb

@@ -0,0 +1,16 @@
+namespace :schema do
+  rails_env = ENV['RAILS_ENV'] || 'development'
+  desc "create schema files in json-schema/*.json"
+  task :build do |t,args|
+    if defined?(Rails) && Rails.respond_to?(:application)
+      # Rails 3
+      Rails.application.initialize!
+    elsif defined?(Rails::Initializer)
+      # Rails 2.3 .. untested
+      $rails_rake_task = false
+      Rails::Initializer.run :load_application_classes
+    end
+    builder = SchemaBuilder::Writer.new
+    builder.write
+  end
+end

data/lib/schema_builder/version.rb

@@ -0,0 +1,3 @@
+module SchemaBuilder
+  VERSION = "0.0.4"
+end

data/lib/{json_schema_builder → schema_builder}/writer.rb

@@ -1,22 +1,29 @@
 require 'active_record'
-module JsonSchemaBuilder
+module SchemaBuilder
 
   # Create json schema files for each model in
   # Rails.root/json-schema/modelName.json
   # @example
-  #   builder = JsonSchemaBuilder::Writer.new
+  #   builder = SchemaBuilder::Writer.new
   #   builder.write
   class Writer
 
     def write
-      res = []
-      create_file_path
+      out = {new: [], old: [] }
+      create_out_path
       models_as_hash.each do |model|
         file = File.join( out_path, "#{model['title'].downcase}.json")
-        File.open( file, 'w+' ) {|f| f.write(JSON.pretty_generate(model)) }
-        res << "#{file} created"
+        if File.exist? file
+          out[:old] << file
+        else
+          File.open( file, 'w+' ) {|f| f.write(JSON.pretty_generate(model)) }
+          out[:new] << "#{file} created"
+        end
       end
-      puts res.join("\n")
+      puts "== Existing Files ==\n" unless out[:old].empty?
+      puts out[:old].join("\n")
+      puts "== New Files ==\n"
+      puts out[:new].join("\n")
     end
 
     def models_as_hash
@@ -54,20 +61,19 @@ module JsonSchemaBuilder
       hsh
     end
 
-    # @return [Array<ActiveRecord::Base>] AR::Base descendant models
+    # @return [Array<Class>] classes(models) descending from ActiveRecord::Base
     def models
-      # require so they are in module scope
       Dir.glob( model_path ).each { |file| require file }
       model_names = Module.constants.select { |c| (eval "#{c}").is_a?(Class) && (eval "#{c}") < ::ActiveRecord::Base }
       model_names.map{|i| "#{i}".constantize}
     end
 
-    def create_file_path
+    def create_out_path
       FileUtils.mkdir_p(out_path) unless File.exists?(out_path)
     end
 
     def model_path
-      @model_path ||= File.join( Dir.pwd, 'app/models', '**/*.rb')
+      @model_path ||= File.join( base_path, 'app/models', '**/*.rb')
     end
 
     # Set the model path
@@ -78,7 +84,7 @@ module JsonSchemaBuilder
 
     # Path to write json files
     def out_path
-      @out_path ||= File.join( Dir.pwd, 'json-schema')
+      @out_path ||= File.join( base_path, 'json-schema')
     end
 
     # @param [String] path to json schema files
@@ -86,6 +92,15 @@ module JsonSchemaBuilder
       @out_path = path
     end
 
+    # Base path to application/framework e.g. Rails.root.
+    # Default to current working dir
+    def base_path
+      @base_path ||= Dir.pwd
+    end
+    def base_path=(path)
+      @base_path = path
+    end
+
     private
 
     # Set the type of the field property
@@ -112,11 +127,11 @@ module JsonSchemaBuilder
     # @param [Symbol] col_type derived from ActiveRecord model
     # @param [Hash{String=>String}] hsh with field properties
     def set_format(col_type, hsh)
-      hsh['format'] = if col_type == :datetime
-                        'date-time'
-                      elsif col_type == :date
-                        'date'
-                      end
+      if col_type == :datetime
+        hsh['format'] = 'date-time'
+      elsif col_type == :date
+        hsh['format']= 'date'
+      end
     end
 
     # Set a field to read-only

data/lib/schema_builder.rb

@@ -0,0 +1,6 @@
+require 'json'
+require 'schema_builder/version'
+require 'schema_builder/writer'
+require 'schema_builder/railtie' if defined? ::Rails::Railtie
+
+module SchemaBuilder;end

data/spec/{json_schema_builder → schema_builder}/writer_spec.rb

@@ -1,10 +1,10 @@
 require 'spec_helper'
 
-describe JsonSchemaBuilder::Writer do
+describe SchemaBuilder::Writer do
 
   context 'in general' do
     before :each do
-      @writer = JsonSchemaBuilder::Writer.new
+      @writer = SchemaBuilder::Writer.new
     end
     it 'should get model_path' do
       @writer.model_path.should == "#{Dir.pwd}/app/models/**/*.rb"
@@ -23,7 +23,7 @@ describe JsonSchemaBuilder::Writer do
 
   context 'file writing' do
     before :each do
-      @writer = JsonSchemaBuilder::Writer.new
+      @writer = SchemaBuilder::Writer.new
       @writer.out_path = test_out_path
       @writer.model_path = File.join( File.expand_path( __FILE__), '../fixtures/*.rb')
       @writer.write

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json_schema_builder
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-29 00:00:00.000000000 Z
+date: 2012-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -139,7 +139,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Build JSON Schema fields for ActiveRecord models
+description: The first step to a clean and simple API is a unified API description
+  in form of a shared JSON Schema
 email:
 - gl@salesking.eu
 executables:
@@ -156,13 +157,16 @@ files:
 - bin/schema
 - json_schema_builder.gemspec
 - lib/json_schema_builder.rb
-- lib/json_schema_builder/version.rb
-- lib/json_schema_builder/writer.rb
+- lib/schema_builder.rb
+- lib/schema_builder/railtie.rb
+- lib/schema_builder/tasks.rb
+- lib/schema_builder/version.rb
+- lib/schema_builder/writer.rb
 - spec/fixtures/ar_schema.rb
 - spec/fixtures/user.rb
-- spec/json_schema_builder/writer_spec.rb
+- spec/schema_builder/writer_spec.rb
 - spec/spec_helper.rb
-homepage: http://www.salesking.eu
+homepage: http://www.salesking.eu/dev
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -176,7 +180,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2999917511580030405
+      hash: -3445288760737026502
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -185,11 +189,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2999917511580030405
+      hash: -3445288760737026502
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Build JSON Schema fields for ActiveRecord models
+summary: A good API needs JSON Schema description! Get it right and build JSON Schemata
+  for your ActiveRecord models
 test_files: []

data/lib/json_schema_builder/version.rb

@@ -1,3 +0,0 @@
-module JsonSchemaBuilder
-  VERSION = "0.0.3"
-end