json_schema_builder 0.0.4 → 0.0.5

data/lib/schema_builder/tasks.rb

@@ -1,16 +1,17 @@
 namespace :schema do
-  rails_env = ENV['RAILS_ENV'] || 'development'
-  desc "create schema files in json-schema/*.json"
+
+  desc "create JSON 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
+    elseif defined?(Rails::Initializer)
+      # Rails 2.3
+      puts "== Hiccup ==\n"
+      puts "Sorry Rails < 3 is not supported\n You can still write a schema by hand .. it's not that difficult.\n Btw. you should move to Rails 3 anyway!"
+      next
     end
     builder = SchemaBuilder::Writer.new
+    builder.routes = Rails.application.routes.routes.routes
     builder.write
   end
 end

data/lib/schema_builder/version.rb

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

data/lib/schema_builder/writer.rb

@@ -7,9 +7,12 @@ module SchemaBuilder
   #   builder = SchemaBuilder::Writer.new
   #   builder.write
   class Writer
+    # [Array<Journey::Routes>] from Rails.application.routes.routes.routes
+    attr_accessor :routes
 
+    # Create schema files
     def write
-      out = {new: [], old: [] }
+      out = {:new => [], :old => [] }
       create_out_path
       models_as_hash.each do |model|
         file = File.join( out_path, "#{model['title'].downcase}.json")
@@ -17,19 +20,22 @@ module SchemaBuilder
           out[:old] << file
         else
           File.open( file, 'w+' ) {|f| f.write(JSON.pretty_generate(model)) }
-          out[:new] << "#{file} created"
+          out[:new] << file
         end
       end
-      puts "== Existing Files ==\n" unless out[:old].empty?
-      puts out[:old].join("\n")
-      puts "== New Files ==\n"
+      unless out[:old].empty?
+        puts "== Existing Files ==\n"
+        puts "Please rename them before they can be re-generated\n"
+        puts out[:old].join("\n")
+      end
+      puts "== Created Files ==\n" unless out[:new].empty?
       puts out[:new].join("\n")
     end
 
     def models_as_hash
       out = []
       models.each do |model|
-        obj = base_hash
+        obj = schema_template
         obj['title'] = model.name
         props = {}
         model.columns_hash.each do |name, col|
@@ -39,19 +45,61 @@ module SchemaBuilder
           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
+        #add links
+        if links = links_as_hash[model.name.tableize]
+          obj['links'] = links
+        end
       end # models
       out
     end
 
+    # Collect links from rails routes
+    # TODO detect nesting /pdts/:pdt_id/pages/:id(.:format)
+    #
+    # @return [Hash{String=>Array<Hash{ String=>String }> } ]
+    #   { 'articles' => [
+    #       { 'rel' => 'create'
+    #         'method' => POST
+    #         'href' => 'articles/'
+    #       },
+    #       {more articles actions}
+    #     ],
+    #    'users' => []
+    #   }
+    def links_as_hash
+      @links ||= begin
+        skip_contrl = ['passwords', 'sessions', 'users', 'admin']
+        skip_actions = ['edit', 'new']
+        out = {}
+        routes.collect do |route|  #Journey::Route object
+          reqs = route.requirements
+          next if reqs.empty? ||
+                  skip_contrl.detect{|c| reqs[:controller][c] } ||
+                  skip_actions.detect{|a| reqs[:action][a]}
+
+          # setup links ary
+          out[ reqs[:controller] ] = [] unless out[reqs[:controller]]
+          # add actions as hash
+          unless out[ reqs[:controller] ].detect{ |i| i[:rel] == reqs[:action] }
+            link = {:rel => reqs[:action],
+                    :method=> route.verb.source.gsub(/[$^]/, ''),
+                    :href => route.path.spec.to_s.gsub(/\(\.:format\)/, '').gsub(/:id/, '{id}')
+                    }
+            out[reqs[:controller]] << link
+          end
+        end if routes
+        out
+      end
+    end
+
     #@return [Hash{String=>Mixed}] base json schema object hash
-    def base_hash
+    def schema_template
       hsh = {}
       hsh['type'] = 'object'
       hsh['title'] = ''

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json_schema_builder
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-30 00:00:00.000000000 Z
+date: 2012-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -180,7 +180,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3445288760737026502
+      hash: 2701833476145455556
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -189,7 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3445288760737026502
+      hash: 2701833476145455556
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24