json_schema_builder 0.0.1 → 0.0.2

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -1,4 +1,2 @@
-source "http://rubygems.org"
-
-# Specify your gem's dependencies in json_schema_builder.gemspec
-gemspec
+source :rubygems
+gemspec

data/{README → README.rdoc}

@@ -1,5 +1,7 @@
 = JSON Schema Builder
 
+{<img src="https://secure.travis-ci.org/salesking/json_schema_builder.png?branch=master" alt="Build Status" />}[http://travis-ci.org/salesking/json_schema_builder]
+
 Build a JSON schema for your ActiveRecord models. STOP your API pains!
 
 The created schema.json files are meant as stubs and need to be enriched with

data/lib/json_schema_builder/version.rb

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

data/lib/json_schema_builder/writer.rb

@@ -11,7 +11,7 @@ module JsonSchemaBuilder
       res = []
       create_file_path
       models_as_hash.each do |model|
-        file = File.join('json-schema',"#{model['title'].downcase}.json")
+        file = File.join( out_path, "#{model['title'].downcase}.json")
         File.open( file, 'w+' ) {|f| f.write(JSON.pretty_generate(model)) }
         res << "#{file} created"
       end
@@ -53,16 +53,36 @@ module JsonSchemaBuilder
       hsh
     end
 
+    # @return [Array<ActiveRecord::Base>] AR::Base descendant models
     def models
-      #TODO call models at least once so they are in module scope .. need to go for file structure
-      root_dir = ROOT
-      Dir.glob( + '/app/models/**/*.rb').each { |file| require file }
+      # 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
-      FileUtils.mkdir('json-schema') unless File.exists?('json-schema')
+      FileUtils.mkdir_p(out_path) unless File.exists?(out_path)
+    end
+
+    def model_path
+      @model_path ||= File.join( Dir.pwd, 'app/models', '**/*.rb')
+    end
+
+    # Set the model path
+    # @param [String] path or file or pattern like models/**/*.rb
+    def model_path=(path)
+      @model_path = path
+    end
+
+    # Path to write json files
+    def out_path
+      @out_path ||= File.join( Dir.pwd, 'json-schema')
+    end
+
+    # @param [String] path to json schema files
+    def out_path=(path)
+      @out_path = path
     end
 
     private

data/spec/json_schema_builder/writer_spec.rb

@@ -2,9 +2,46 @@ require 'spec_helper'
 
 describe JsonSchemaBuilder::Writer do
 
-  it "should get models" do
-    a = JsonSchemaBuilder::Writer.new
-    a.write.should == 'write real specs .. check spec folder til than'
+  context 'in general' do
+    before :each do
+      @writer = JsonSchemaBuilder::Writer.new
+    end
+    it 'should get model_path' do
+      @writer.model_path.should == "#{Dir.pwd}/app/models/**/*.rb"
+    end
+
+    it 'should set model_path' do
+      path = 'some/model-folder/*.*.rb'
+      @writer.model_path = path
+      @writer.model_path.should == path
+    end
+
+    it 'should get models' do
+      @writer.models.should include(User)
+    end
+  end
+
+  context 'file writing' do
+    before :each do
+      @writer = JsonSchemaBuilder::Writer.new
+      @writer.out_path = test_out_path
+      @writer.model_path = File.join( File.expand_path( __FILE__), '../fixtures/*.rb')
+      @writer.write
+      @file_path =  File.join(test_out_path, 'user.json')
+    end
+
+    it 'should write file' do
+      File.exist?( @file_path ).should be
+      File.delete @file_path
+    end
+
+    it 'should write valid json' do
+      hsh = JSON.parse( File.read @file_path)
+      hsh['type'].should == 'object'
+      hsh['title'].should == 'User'
+      field_names = hsh['properties'].keys
+      field_names.should include 'id', 'number', 'birthday', 'is_admin', 'notes'
+    end
   end
 
 end

data/spec/spec_helper.rb

@@ -18,10 +18,17 @@ RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
+  config.after(:all) do
+    FileUtils.rm_rf(test_out_path)
+  end
 end
 
 ActiveRecord::Base.establish_connection({
   'adapter' => 'sqlite3',
   'database' => ':memory:'
 })
-load(File.join(File.dirname(__FILE__), 'fixtures/ar_schema.rb'))
+load(File.join(File.dirname(__FILE__), 'fixtures/ar_schema.rb'))
+
+def test_out_path
+  File.join( File.dirname( __FILE__), 'tmp')
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json_schema_builder
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -143,16 +143,17 @@ description: Build JSON Schema fields for ActiveRecord models
 email:
 - gl@salesking.eu
 executables:
-- schema.rb
+- schema
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
-- README
+- README.rdoc
 - Rakefile
-- bin/schema.rb
+- bin/schema
 - json_schema_builder.gemspec
 - lib/json_schema_builder.rb
 - lib/json_schema_builder/version.rb
@@ -175,7 +176,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1344306613222541531
+      hash: -4247510019183941488
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -184,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1344306613222541531
+      hash: -4247510019183941488
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24