jsonschema_serializer 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1eb0905f97429a33e3a48f272ac469ed4bd674c
-  data.tar.gz: e5e879561a2e825f7a55c68046a388e735ca60ff
+  metadata.gz: 21bc2f5a22f0f4da198b981fd6be8aade090d4fa
+  data.tar.gz: 9d08bc5bf5c24b2bd5cec7ac1f7dfb8914374708
 SHA512:
-  metadata.gz: 332c7b8572a005b88a2fcc81b422deef2fe02c7415b3d18771c2235f7f6b138ce075a7eea28185cf8d9f76f8974c5fe09021f2a9e9a5ef5cc9841350af1c04cd
-  data.tar.gz: 9cb94fd3d015da0a8d0cbf5436be5de272cbe3c8334c67b37373fac51a0557b0330e1d0ee81addeb6bc2e85d132ea4e415cd830d3b0be883420c6a29a01e6c64
+  metadata.gz: 55d072167b46b7999861a0d6c152753ca46a490b3f3e0386867dfc6d084c9cfc287af7acf4248f6e6039d74ab84133c59f11e19ee79b2fe52caa0c259875f62f
+  data.tar.gz: 21b742e2afb0e3598667b4f3e9c75017cdf0096dc7a51808d99a1b4b669b256be42c9ebec4e7df479f47e92c3dcf552010ec3d0fa36dd3256428258e8026f0fc

data/CHANGELOG.md

@@ -1,19 +1,27 @@
 # Changelog
 
-# v 0.0.4 (2018-05-22)
+## v 0.0.5 (2018-05-23)
+
+- json pretty generation by default
+- added a Rails rake task example in the README.md
+- added schema `title` and `required` attributes
+- refactored `from_active_record` method in `from_model`
+- manipulate a dup of table columns
+
+## v 0.0.4 (2018-05-22)
 
 - corrected `ActiveRecord::ConnectionAdapters::SqlTypeMetadata` reference in `JsonschemaSerializer::ActiveRecord`
 
-# v 0.0.3 (2018-05-21)
+## v 0.0.3 (2018-05-21)
 
 - improved documentation on existing code base
 - refactored `JsonschemaSerializer::ActiveRecord` as a `class`
 
-# v 0.0.2 (2018-05-20)
+## v 0.0.2 (2018-05-20)
 
 - basic rDoc comments for documentation
 
-# v 0.0.1 (2018-05-20)
+## v 0.0.1 (2018-05-20)
 
 - basic implementation of `JsonschemaSerializer::Builder`
 - POC implementation of a `JsonschemaSerializer::ActiveRecord` module

data/README.md

@@ -61,9 +61,9 @@ You can alternatively use an experimental builder for `ActiveRecord`
 ```ruby
 serializer = JsonschemaSerializer::ActiveRecord
 
-schema = serializer.from_active_record(MyActiveRecordClass)
-schema = serializer.from_active_record(MyActiveRecordClass, only: %[desired1 desired2])
-schema = serializer.from_active_record(MyActiveRecordClass, except: %[ignored1 ignored2])
+schema = serializer.from_model(MyActiveRecordClass)
+schema = serializer.from_model(MyActiveRecordClass, only: %[desired1 desired2])
+schema = serializer.from_model(MyActiveRecordClass, except: %[ignored1 ignored2])
 
 # You can manipulate the resulting schema
 
@@ -75,6 +75,38 @@ end
 schema.to_json
 ```
 
+## Rails
+
+At this stage, a first usage within a Rails application could be a rake task dumping the schemas inside the public folder.
+
+```rb
+# lib/tasks/jsonschemas.rake
+require 'fileutils'
+
+task dump_jsonschemas: :environment do
+  Rails.application.eager_load!
+  models = ActiveRecord::Base.descendants
+
+  output_path = Rails.root.join('public', 'data')
+  # Ensure that the destination path exists
+  FileUtils.mkdir_p(output_path)
+
+  models.each do |model|
+    # Skip abstract classes
+    if model.table_name
+      file_path = output_path.join("#{model.model_name.param_key}.json")
+      schema = JsonschemaSerializer::ActiveRecord.from_model(model)
+
+      puts "Creating #{file_path} ..."
+      File.open(file_path, 'w') { |f| f.write(schema.to_json) }
+    else
+      puts "Skipping abstract class #{model.to_s} ..."
+    end
+  end
+end
+
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -84,4 +116,3 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/mberlanda/jsonschema_serializer.
-ygy

data/lib/jsonschema_serializer/active_record.rb

@@ -1,8 +1,8 @@
 require_relative 'builder'
 
 module JsonschemaSerializer
-  # The +JsonschemaSerializer::Activerecord+ class provides
-  # a +from_active_record+ class method to serialize some
+  # The +JsonschemaSerializer::ActiveRecord+ class provides
+  # a +from_model+ class method to serialize some
   # ActiveRecord classes with the minimum effort
   class ActiveRecord
     class << self
@@ -14,36 +14,105 @@ module JsonschemaSerializer
       # +only+:: +Array+ columns as +String+
       # +except+:: +Array+ columns as +String+
 
-      def from_active_record(klass, only: nil, except: nil)
+      def from_model(klass, only: nil, except: nil)
         validate_arguments(only, except)
         JsonschemaSerializer::Builder.build do |b|
-          selected_columns(klass, only, except).each do |col|
-            b.properties.tap do |prop|
-              el = format_column_element(col)
-              # Handle basic case of attribute type and attribute name
-              prop.merge! b.send(el[:type], el[:name])
-            end
-          end
+          format_schema_attributes(klass, b)
+          format_schema_properties(selected_columns(klass), b)
         end
       end
 
-      private
-
       # Raise if +only+ and +except+ are both provided
+      #
+      # Params:
+      # +only+:: +Array+ columns as +String+
+      # +except+:: +Array+ columns as +String+
+
       def validate_arguments(only, except)
         raise ArgumentError, 'only and except options both provided' if only && except
+        @only = only
+        @except = except
+      end
+
+      # Format JsonSchema general attributes such as title, required
+      #
+      # Params:
+      # +klass+:: +ActiveRecord::Base+ class name
+      # +builder+:: +JsonschemaSerializer::Builder+ an instance of the builder
+
+      def format_schema_attributes(klass, builder)
+        builder.title schema_title(klass)
+        required(klass).tap do |required|
+          builder.required required unless required.empty?
+        end
+      end
+
+      # Format JsonSchema properties
+      #
+      # Params:
+      # +columns+:: +Array+ array of formatted
+      # +builder+:: +JsonschemaSerializer::Builder+ an instance of the builder
+
+      def format_schema_properties(columns, builder)
+        builder.properties.tap do |prop|
+          columns.each do |col|
+            el = format_column_element(col)
+            # Handle basic case of attribute type and attribute name
+            prop.merge! builder.send(el[:type], el[:name])
+          end
+        end
+      end
+
+      # Extract schema title from ActiveRecord class
+      # This method can be overridden when inheriting from this class
+      #
+      # Params:
+      # +klass+:: +ActiveRecord::Base+ class name
+
+      def schema_title(klass)
+        klass.model_name.human
+      end
+
+      # Filter required ActiveRecord class implementation with only/except
+      #
+      # Params:
+      # +columns+:: +Array+ column names as +Symbol+
+
+      # Extract required attributes from ActiveRecord class implementation
+      # This method can be overridden when inheriting from this class
+      #
+      # Params:
+      # +klass+:: +ActiveRecord::Base+ class name
+      def required(klass)
+        required_from_class(klass).tap do |req|
+          return req & @only if @only
+          return req - @except if @except
+        end
+      end
+
+      def required_from_class(klass)
+        klass.validators.select do |validator|
+          validator.class.to_s == 'ActiveRecord::Validations::PresenceValidator'
+        end.map(&:attributes).flatten
       end
 
       # Retrieves the columns and keep/discard some elements if needed
-      def selected_columns(klass, only, except)
-        klass.columns.tap do |cols|
-          cols.select! { |col| only.include?(col.name) } if only
-          cols.reject! { |col| except.include?(col.name) } if except
+      #
+      # Params:
+      # +klass+:: +ActiveRecord::Base+ class name
+      # +only+:: +Array+ columns as +String+
+      # +except+:: +Array+ columns as +String+
+
+      def selected_columns(klass)
+        klass.columns.dup.tap do |cols|
+          cols.select! { |col| @only.include?(col.name) } if @only
+          cols.reject! { |col| @except.include?(col.name) } if @except
         end
       end
 
       # Mapping Ruby types on Jsonschema types.
       # This could be moved to a separate module later
+
       TYPE_CONVERSIONS = {
         boolean: :boolean,
         datetime: :string,
@@ -54,6 +123,10 @@ module JsonschemaSerializer
       }.freeze
 
       # Format a ActiveRecord::ConnectionAdapters::<Adapter>::Column as an Hash
+      #
+      # Params:
+      # +klass+:: +ActiveRecord::ConnectionAdapters::<Adapter>::Column+ column
+
       def format_column_element(col)
         {}.tap do |h|
           h[:name] = col.name
@@ -62,7 +135,11 @@ module JsonschemaSerializer
         end
       end
 
-      # Format a ActiveRecord::ConnectionAdapters::SqlTypeMetadata as an Hash
+      # Retrieves type from ActiveRecord::ConnectionAdapters::SqlTypeMetadata
+      #
+      # Params:
+      # +col+:: +ActiveRecord::ConnectionAdapters::<Adapter>::Column+ column
+
       def sql_type(col)
         col.sql_type_metadata.type
       end

data/lib/jsonschema_serializer/builder.rb

@@ -23,8 +23,13 @@ module JsonschemaSerializer
     end
 
     # The +to_json+ method exports the schema as a json string
-    def to_json
-      @schema.to_json
+    # By default it would exported with a pretty print
+    #
+    # Params:
+    # +pretty+:: +Boolean+
+
+    def to_json(pretty: true)
+      pretty ? JSON.pretty_generate(@schema) : @schema.to_json
     end
 
     # Assigns the +title+ to the root schema object
@@ -193,7 +198,7 @@ module JsonschemaSerializer
     #     end
     #     b.array :subscribers, items: subscriber
     #   end
-    #
+
     def array(name, items:, **opts)
       {
         name => { type: :array, items: items }.merge(opts)

data/lib/jsonschema_serializer/version.rb

@@ -1,3 +1,3 @@
 module JsonschemaSerializer
-  VERSION = '0.0.4'.freeze # :nodoc:
+  VERSION = '0.0.5'.freeze # :nodoc:
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonschema_serializer
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Mauro Berlanda
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-22 00:00:00.000000000 Z
+date: 2018-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler