json_schema_builder 0.0.6 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0e7fff37867006fadd7e9eeb05cbccda42c33a53
+  data.tar.gz: 583a3e047a665906252b678ea8a99c6c7cb9fb35
+SHA512:
+  metadata.gz: be5c6c2757a458504b4e55ef1e5443139f6fe8d82c512cdc670b77ce751cb9f1ea493d20e12f35b7f8d21e83e2e68be1934f8c9b5a2b4952fbee63169822b2cc
+  data.tar.gz: 62877138244e2bad27e0950823741ed0a0f5e42f61a6b701fa1efee6670d587e8e2873ebc2b07c4b0fbcd8d08726d2701ce203cfa697051d7cc6e39766e1df46

data/.travis.yml

@@ -1,4 +1,6 @@
+# force a recent version as long as the default is too old
+before_install:
+  - gem install bundler -v 1.11
 rvm:
-  - 1.8.7
-  - 1.9.2
+  - 2.2
   - 1.9.3

data/Gemfile

@@ -1,2 +1,2 @@
-source :rubygems
+source "https://rubygems.org"
 gemspec

data/{README.rdoc → README.md}

@@ -1,6 +1,6 @@
-= JSON Schema Builder
+# 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 Status](https://travis-ci.org/salesking/json_schema_builder.svg)](https://travis-ci.org/salesking/json_schema_builder)
 
 Build a JSON schema for your ActiveRecord models. STOP your API pains!
 
@@ -8,21 +8,28 @@ The created schema.json files are meant as stubs and need to be enriched with
 field descriptions and names. You might also want to remove or add object
 properties, since the gem only uses the available ActiveRecord database fields.
 
-== Usage
+## Usage
 
 Hook the gem into your rails app and create the schema files.
-
+rake re
   gem 'json_schema_builder'
-
   rake schema:build
 
 Your Models and their fields are written into JSON files which you can
 pimp further.
 
-== Test
+## Supports
+
+* ruby 1.9, 2.2
+* active_record > 4 (use gem version < 0.1.0 for older versions)
+
+## Test
 
   bundle install
   bundle exec rake spec
 
+## Contribute 
+
+Feel free to fork and add features or fixes for other ActiveRecord versions
 
 Copyright Georg Leciejewski, MIT License

data/Rakefile

@@ -1,12 +1,12 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rspec'
 require 'rspec/core/rake_task'
 
 desc 'Default: run specs.'
 task :default => :spec
 
-desc "Run specs"
+desc 'Run specs'
 RSpec::Core::RakeTask.new do |t|
-  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  # t.pattern = './spec/**/*_spec.rb' # it's default.
   # Put spec opts in a file named .rspec in root
 end

data/lib/schema_builder/railtie.rb

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

data/lib/schema_builder/version.rb

@@ -1,3 +1,3 @@
 module SchemaBuilder
-  VERSION = "0.0.6"
+  VERSION = "0.1.0"
 end

data/lib/schema_builder/writer.rb

@@ -15,10 +15,11 @@ module SchemaBuilder
       out = {:new => [], :old => [] }
       create_out_path
       models_as_hash.each do |model|
-        file = File.join( out_path, "#{model['title'].downcase}.json")
+        file = File.join( out_path, "#{model['name']}.json")
         if File.exist? file
           out[:old] << file
         else
+          FileUtils.mkdir_p(File.dirname(file))
           File.open( file, 'w+' ) {|f| f.write(JSON.pretty_generate(model)) }
           out[:new] << file
         end
@@ -36,12 +37,13 @@ module SchemaBuilder
       out = []
       models.each do |model|
         obj = schema_template
-        obj['title'] = model.name
+        obj['name'] = model.name.underscore
+        obj['title'] = model.model_name.human
         props = {}
         model.columns_hash.each do |name, col|
           prop = {}
           prop['description'] = 'the field description'
-          prop['identity'] = true if col.primary
+          prop['identity'] = true if model.primary_key.to_s == name
           set_readonly(name,prop)
           set_type(col.type, prop)
           set_format(col.type, prop)
@@ -81,7 +83,13 @@ module SchemaBuilder
           reqs = route.requirements
           next if reqs.empty? ||
                   skip_contrl.detect{|c| reqs[:controller][c] } ||
-                  skip_actions.detect{|a| reqs[:action][a]}
+                  skip_actions.detect{|a|
+                    if reqs[:action].is_a?(Hash)
+                      reqs[:action][a]
+                    elsif reqs[:action].is_a?(Regexp)
+                      reqs[:action].match(a)
+                    end
+                  }
 
           # setup links ary
           out[ reqs[:controller] ] = [] unless out[reqs[:controller]]
@@ -114,6 +122,8 @@ module SchemaBuilder
       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}
+      #::Rails.application.eager_load!
+      #ActiveRecord::Base.descendants
     end
 
     def create_out_path

data/spec/fixtures/ar_schema.rb

@@ -8,6 +8,6 @@ ActiveRecord::Schema.define(:version => 0) do
     t.boolean :is_admin
     t.text :notes
     t.date :birthday
-    t.timestamps
+    t.timestamps null: false
   end
 end

data/spec/schema_builder/writer_spec.rb

@@ -7,17 +7,32 @@ describe SchemaBuilder::Writer do
       @writer = SchemaBuilder::Writer.new
     end
     it 'should get model_path' do
-      @writer.model_path.should == "#{Dir.pwd}/app/models/**/*.rb"
+      expect(@writer.model_path).to eq "#{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
+      expect(@writer.model_path).to eq path
     end
 
     it 'should get models' do
-      @writer.models.should include(User)
+      expect(@writer.models).to include(User)
+    end
+  end
+
+  context 'model naming' do
+    before :each do
+      @writer = SchemaBuilder::Writer.new
+      @user_hash = @writer.models_as_hash.first
+    end
+
+    it 'should set title to model human name' do
+      expect(@user_hash['title']).to eq 'User'
+    end
+
+    it 'should set name to lowercase model name' do
+      expect(@user_hash['name']).to eq 'user'
     end
   end
 
@@ -31,16 +46,16 @@ describe SchemaBuilder::Writer do
     end
 
     it 'should write file' do
-      File.exist?( @file_path ).should be
+      expect(File.exist?( @file_path )).to 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'
+      expect(hsh['type']).to eq 'object'
+      expect(hsh['title']).to eq 'User'
       field_names = hsh['properties'].keys
-      field_names.should include 'id', 'number', 'birthday', 'is_admin', 'notes'
+      expect(field_names).to include 'id', 'number', 'birthday', 'is_admin', 'notes'
     end
   end
 

data/spec/spec_helper.rb

@@ -15,7 +15,6 @@ require 'json_schema_builder'
 require 'fixtures/user'
 
 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

metadata

@@ -1,142 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: json_schema_builder
 version: !ruby/object:Gem::Version
-  version: 0.0.6
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Georg Leciejewski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-01 00:00:00.000000000 Z
+date: 2016-01-12 00:00:00.000000000 Z
 dependencies:
 - !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: gli
   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: activesupport
   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: rake
   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: simplecov
   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: 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: The first step to a clean and simple API is a unified API description
@@ -148,11 +131,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
-- README.rdoc
+- README.md
 - Rakefile
 - bin/schema
 - json_schema_builder.gemspec
@@ -168,33 +150,26 @@ files:
 - spec/spec_helper.rb
 homepage: http://www.salesking.eu/dev
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -51753238081111492
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -51753238081111492
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.4.8
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A good API needs JSON Schema description! Get it right and build JSON Schemata
   for your ActiveRecord models
 test_files: []

data/.rspec

@@ -1,2 +0,0 @@
---color
---format progress