json_schema_builder 0.0.1

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc
+coverage
+json-schema/

data/.rspec

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

data/Gemfile

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

data/README

@@ -0,0 +1,26 @@
+= 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
+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
+
+Hook the gem into your rails app and create the schema files.
+
+  gem 'json_schema_builder'
+
+  schema build
+
+Your Models and their fields are written into JSON files which you can
+pimp further.
+
+== Test
+
+  bundle install
+  bundle exec rake spec
+
+
+Copyright Georg Leciejewski, MIT License

data/Rakefile

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

data/bin/schema.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
+
+require 'json_schema_builder'
+
+require 'gli'
+include GLI
+
+version JsonSchemaBuilder::VERSION
+
+desc "Creates schema file in current directory/json-schema/*.json"
+command :build do |c|
+  c.action do |global_options, options, args|
+    builder = JsonSchemaBuilder::Writer.new
+    builder.write
+  end
+end
+
+exit GLI.run(ARGV)

data/json_schema_builder.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "json_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.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'json'
+  s.add_dependency 'gli'
+  s.add_dependency 'activesupport'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'activerecord'
+  s.add_development_dependency 'sqlite3'
+end

data/lib/json_schema_builder/version.rb

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

data/lib/json_schema_builder/writer.rb

@@ -0,0 +1,108 @@
+module JsonSchemaBuilder
+
+  # Create json schema files for each model in
+  # Rails.root/json-schema/modelName.json
+  # @example
+  #   builder = JsonSchemaBuilder::Writer.new
+  #   builder.write
+  class Writer
+
+    def write
+      res = []
+      create_file_path
+      models_as_hash.each do |model|
+        file = File.join('json-schema',"#{model['title'].downcase}.json")
+        File.open( file, 'w+' ) {|f| f.write(JSON.pretty_generate(model)) }
+        res << "#{file} created"
+      end
+      puts res.join("\n")
+    end
+
+    def models_as_hash
+      out = []
+      models.each do |model|
+        obj = base_hash
+        obj['title'] = model.name
+        props = {}
+        model.columns_hash.each do |name, col|
+          prop = {}
+          prop['description'] = 'the field description'
+          prop['identity'] = true if col.primary
+          set_readonly(name,prop)
+          set_type(col.type, prop)
+          set_format(col.type, prop)
+
+          prop['default'] = col.default if col.default
+          prop['maxlength'] = col.limit if col.type == :string && col.limit
+          props["#{name}"] = prop
+        end
+        obj['properties'] = props
+        out << obj
+      end # models
+      out
+    end
+
+    #@return [Hash{String=>Mixed}] base json schema object hash
+    def base_hash
+      hsh = {}
+      hsh['type'] = 'object'
+      hsh['title'] = ''
+      hsh['description'] = 'object'
+      hsh['properties'] = {}
+      hsh['links'] = []
+      hsh
+    end
+
+    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 }
+      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')
+    end
+
+    private
+
+    # Set the type of the field property
+    # JSON Schema types
+    # - string
+    # - number  Value MUST be a number, floating point numbers are
+    #   allowed.
+    # - integer  Value MUST be an integer, no floating point numbers are
+    #   allowed.  This is a subset of the number type.
+    # - boolean
+    # @param [Symbol] col_type derived from ActiveRecord model
+    # @param [Hash{String=>String}] hsh with field properties
+    def set_type(col_type, hsh)
+      hsh['type'] = if [:date, :datetime, :text].include?(col_type)
+                       'string'
+                    elsif col_type == :decimal
+                      'number'
+                    else
+                      "#{col_type}"
+                    end
+    end
+
+    # Set the format for a field property
+    # @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
+    end
+
+    # Set a field to read-only
+    # @param [String] col_name derived from ActiveRecord model
+    # @param [Hash{String=>String}] hsh with field properties
+    def set_readonly(col_name, hsh)
+      hsh['readonly'] = true if ['created_at', 'updated_at', 'id'].include?(col_name)
+    end
+  end
+end

data/lib/json_schema_builder.rb

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

data/spec/fixtures/ar_schema.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+ActiveRecord::Schema.define(:version => 0) do
+
+  create_table :users do |t|
+    t.integer :number
+    t.string :name, :limit => 128
+    t.decimal :amount, :precision => 16, :scale => 4
+    t.boolean :is_admin
+    t.text :notes
+    t.date :birthday
+    t.timestamps
+  end
+end

data/spec/fixtures/user.rb

@@ -0,0 +1,2 @@
+class User < ActiveRecord::Base
+end

data/spec/json_schema_builder/writer_spec.rb

@@ -0,0 +1,10 @@
+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'
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+require 'simplecov'
+require 'active_record'
+require 'active_support'
+
+SimpleCov.start do
+  root File.join(File.dirname(__FILE__), '..')
+  add_filter "/bin/"
+  add_filter "/spec/"
+end
+
+$:.unshift(File.dirname(__FILE__))
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+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
+end
+
+ActiveRecord::Base.establish_connection({
+  'adapter' => 'sqlite3',
+  'database' => ':memory:'
+})
+load(File.join(File.dirname(__FILE__), 'fixtures/ar_schema.rb'))

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: json_schema_builder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Georg Leciejewski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-29 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: Build JSON Schema fields for ActiveRecord models
+email:
+- gl@salesking.eu
+executables:
+- schema.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README
+- Rakefile
+- bin/schema.rb
+- json_schema_builder.gemspec
+- lib/json_schema_builder.rb
+- lib/json_schema_builder/version.rb
+- lib/json_schema_builder/writer.rb
+- spec/fixtures/ar_schema.rb
+- spec/fixtures/user.rb
+- spec/json_schema_builder/writer_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.salesking.eu
+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'
+      segments:
+      - 0
+      hash: 1344306613222541531
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1344306613222541531
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Build JSON Schema fields for ActiveRecord models
+test_files: []