json_schema_view 0.1.0

data/lib/json_schema_view/rails/generators/install/templates/example/todo_list_component.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "json_schema_view"
+
+# This is an example definition of a component.
+#
+# @example You can use this component in a view like following code:
+#   todo_items = [{ title: "Buy milk", done: false }, { title: "Buy eggs", done: true, note: "Large eggs are better" }]
+#   render ExampleTodoListComponent.new(props: { todo_items: todo_items })
+#
+# @example Extract the JSON Schema of this component:
+#   ExampleTodoListComponent.props_class.to_json_schema
+#   # => {
+#     "properties": {
+#       "type": "array",
+#       "items": {
+#         "type": "object",
+#         "properties": {
+#           "name": {
+#             "description": "The title of TODO item.",
+#             "type": "string"
+#           },
+#           "done": {
+#             "description": "Whether the TODO item is done or not.",
+#             "type": ["boolean"]
+#           },
+#           "note": {
+#             "description": "The additional description of TODO item.",
+#             "type": ["string"]
+#           }
+#         },
+#         "required": ["name", "done"],
+#         "additionalProperties": false
+#       }
+#     }
+#     "required": ["todo_items"],
+#     "additionalProperties": false
+#   }
+#
+class ExampleTodoListComponent < BaseComponent
+  # props_class defines the properties class for the component.
+  # properties class is a special form of {JsonSchemaDefinable}. its instance is used by renderer to render component's content.
+  props_class do
+    # Some class methods (properties, description, additional_properties, etc.) are provided to define the JSON Schema of the class.
+    # Property
+    #
+    # @see https://json-schema.org/understanding-json-schema/reference/object.html#properties
+    property(
+      :todo_items,
+      # To type keyword, you can pass some primitive classes (String, Integer, TrueClass, Array, ...etc), a hash representing JSON Schema, an {JsonSchemaDefinable}.
+      type: Array,
+      item: {
+        type: TodoItemResource
+      },
+    )
+
+    # @param todo_items [Array<Hash>] An array of todo items ({ name: String, done: Boolean, note: String or nil }).
+    def initialize(todo_items:)
+      @todo_items = todo_items
+    end
+
+    # @return [Array<ExampleTodoItemResource>]
+    def todo_items
+      @todo_items.map { |todo_item| ExampleTodoItemResource.new(todo_item) }
+    end
+  end
+end

data/lib/json_schema_view/rails/generators/install/templates/initializer.rb.tt

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "json_schema_view"
+
+Rails.application.config.autoload_paths += [Rails.root.join("<%= components_path %>")]
+
+# You can export your components' schemas by running:
+# 
+#  $ rake json_schema_view:export:primary
+Rails.application.config.json_schema_view.schema_sets = {
+  "primary": "<%= schema_set_class_name %>",
+}
+
+# Validate component with its schema on render.
+Rails.application.config.json_schema_view.validate_by_default = true

data/lib/json_schema_view/rails/generators.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module JsonSchemaView
+  # A collection of rails generators.
+  module Generators
+    require_relative "generators/install/install_generator"
+  end
+end

data/lib/json_schema_view/rails/rails_engine.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "rails"
+
+module JsonSchemaView
+  # :nodoc:
+  class RailsEngine < ::Rails::Engine
+    rake_tasks do
+      load "json_schema_view/rails/tasks/json_schema_view.rake"
+    end
+
+    generators do
+      require_relative "generators"
+    end
+
+    config.before_configuration do
+      Rails.application.config.json_schema_view = Configuration.instance
+    end
+  end
+end

data/lib/json_schema_view/rails/tasks/json_schema_component.rake

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+namespace :json_schema_view do
+  desc "Export json schemas in the specified schema set"
+  task :export, [:schema_set] => [:environment] do |_task, args|
+    schema_set = JsonSchemaView.configuration.schema_sets.fetch_instance(args[:schema_set])
+    schema_set.export_json_schemas(print_logs: true)
+  end
+end

data/lib/json_schema_view/rails.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+begin
+  require "rails"
+  require_relative "rails/rails_engine"
+rescue LoadError
+  # Skip loading modules about rails if Rails is not available.
+end

data/lib/json_schema_view/renderers/base.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module JsonSchemaView
+  module Renderers
+    # Render {BaseComponent} in a view.
+    # @abstract
+    class Base
+      # @return [BaseComponent]
+      attr_reader :component
+
+      # @param component [BaseComponent] The component to render.
+      def initialize(component)
+        @component = component
+      end
+
+      # Render the React component by using react_on_rails.
+      # This method is used by {ActionView::Template::Renderable}.
+      #
+      # @see https://guides.rubyonrails.org/layouts_and_rendering.html#rendering-objects
+      # @param view_content [Object]
+      # @return [String]
+      def render_in(view_context)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/json_schema_view/renderers/json.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module JsonSchemaView
+  module Renderers
+    # Render {BaseComponent} as json.
+    class Json < Base
+      # Render the React component by using react_on_rails.
+      # This method is used by {ActionView::Template::Renderable}.
+      #
+      # @param view_content [Object]
+      # @return [String]
+      def render_in(view_context)
+        view_context.render
+        view_context.render(json: component.props.to_json)
+      end
+
+      # Returns the content type of the response.
+      # This method is used by {ActionView::Template::Renderable}.
+      #
+      # @return [Symbol]
+      def format
+        :json
+      end
+    end
+  end
+end

data/lib/json_schema_view/renderers/react_on_rails.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module JsonSchemaView
+  module Renderers
+    # Render a React component by using {https://github.com/shakacode/react_on_rails}.
+    class ReactOnRails < Base
+      # @param view_content [Object]
+      # @param options (see ReactOnRailsHelper#react_component)
+      # @return [String]
+      def render_in(view_context, **options)
+        view_context.react_component(component.component_name, props: component.props.as_json, **options)
+      end
+    end
+  end
+end

data/lib/json_schema_view/renderers.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module JsonSchemaView
+  # Renderers module contains classes that render a component.
+  module Renderers
+    require_relative "renderers/base"
+    require_relative "renderers/json"
+    require_relative "renderers/react_on_rails"
+
+    # @param name [Symbol]
+    def self.find_by_name(name)
+      case name
+      when :json
+        Json
+      when :react_on_rails
+        ReactOnRails
+      else
+        raise ArgumentError, "Unknown renderer: #{name}"
+      end
+    end
+  end
+end

data/lib/json_schema_view/schema_set/constant_search_helper.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "pathname"
+
+module JsonSchemaView
+  class SchemaSet
+    # Add methods to search constants in the directory to SchemaSet.
+    module ConstantSearchHelper
+      # @return [Array<Class<BaseComponent>>]
+      def search_component_classes(path_pattern: nil)
+        constants = path_pattern ? search_constants(path_pattern) : all_constants
+        constants.select { |const| const.is_a?(Class) && const < JsonSchemaView::BaseComponent }
+      end
+
+      # @return [Array<Class, Module>]
+      def search_constants(path_pattern: "**/*.rb")
+        loader = ConstantAutoLoader.from_rails_app
+
+        root_pathname = Pathname.new(root_path)
+        Dir.glob(path_pattern, base: root_path).filter_map do |path|
+          path = root_pathname.join(path)
+          loader.load_constant_by_path(path)
+        end
+      end
+
+      # @return [Array<Class, Module>]
+      def all_constants
+        @all_constants ||= search_constants(path_pattern: "**/*.rb")
+      end
+
+      # Load corresponding constant for the path by using Rails's autoloader.
+      class ConstantAutoLoader
+        # @return [ConstantAutoLoader]
+        def self.from_rails_app
+          autoload_paths = [
+            *Rails.application.config.eager_load_paths,
+            *Rails.application.config.autoload_once_paths,
+            *Rails.application.config.autoload_paths
+          ]
+
+          new(autoload_paths: autoload_paths)
+        end
+
+        # @return [Array<Pathname>]
+        attr_reader :autoload_paths
+
+        # @param autoload_paths [Array<String>]
+        def initialize(autoload_paths:)
+          @autoload_paths = autoload_paths.map { |path| Pathname.new(path) }
+        end
+
+        # @param path [String, Pathname]
+        # @return [Object]
+        def load_constant_by_path(path)
+          autoload_base_path = nearest_autoload_path(path)
+          return nil unless autoload_base_path
+
+          rel_path = child_path(path, autoload_base_path)
+          return nil unless rel_path
+
+          ActiveSupport::Inflector.safe_constantize(constant_name_from_path(rel_path))
+        end
+
+        private
+
+        # @param path [Pathname]
+        # @return [String]
+        def constant_name_from_path(path)
+          path = remove_extname(path)
+          classified = ActiveSupport::Inflector.classify(path.to_s)
+
+          # Make absolute constant path
+          if classified.start_with?("::")
+            classified == "::" ? "::Object" : classified
+          else
+            "::#{classified}"
+          end
+        end
+
+        # @param path [Pathname]
+        # @return [Pathname]
+        def remove_extname(path)
+          # Repeat for the case of multiple extensions (e.g. .min.rb)
+          until path.extname.empty?
+            removed = path.to_s.delete_suffix(path.extname)
+            path = Pathname.new(removed)
+          end
+
+          path
+        end
+
+        # @param path [String]
+        # @return [Pathname, nil]
+        def nearest_autoload_path(path)
+          matches = autoload_paths.filter_map do |autoload_path|
+            rel_path = child_path(path, autoload_path)
+            rel_path && [autoload_path, rel_path]
+          end
+          matches.min_by { |(_autoload_path, rel_path)| rel_path.to_s.length }&.first
+        end
+
+        # @param path [Pathname]
+        # @param dir_path [Pathname]
+        # @return [Pathname, nil]
+        def child_path(path, base_dir_path)
+          path = Pathname.new(path).realpath
+          relative_path = path.relative_path_from(base_dir_path)
+          relative_path.to_s.start_with?("../") ? nil : relative_path
+        end
+      end
+    end
+  end
+end

data/lib/json_schema_view/schema_set.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "forwardable"
+require "pathname"
+require "fileutils"
+
+module JsonSchemaView
+  # Builder build components
+  class SchemaSet
+    require_relative "schema_set/constant_search_helper"
+
+    include ConstantSearchHelper
+
+    # @abstract
+    # @return [String]
+    def root_path
+      raise NotImplementedError
+    end
+
+    # @abstract
+    # @return [String]
+    def export_path
+      raise NotImplementedError
+    end
+
+    # @return [Array<Class<JsonSchemaDefinable>>]
+    def resource_classes_to_export
+      []
+    end
+
+    # @return [void]
+    def export_json_schemas(print_logs: false)
+      puts "Exports resource classes in #{self.class.name}..." if print_logs
+      export_pathname = Pathname.new(export_path)
+
+      exports = resource_classes_to_export.map do |resource_class|
+        destination = export_pathname.join("#{resource_class.name.demodulize}.json")
+        klass = resource_class < JsonSchemaView::BaseComponent ? resource_class.props_class : resource_class
+
+        [destination, resource_class, klass.to_json_schema]
+      end
+
+      clear_export_path
+
+      exports.each do |destination, resource_class, json_schema|
+        FileUtils.mkdir_p(destination.dirname)
+        destination.write(json_schema)
+        puts "#{resource_class.name} -> #{destination}" if print_logs
+      end
+    end
+
+    # @return [void]
+    def clear_export_path
+      FileUtils.rm_rf(export_path) if Dir.exist?(export_path)
+    end
+  end
+end

data/lib/json_schema_view/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JsonSchemaView
+  VERSION = "0.1.0"
+end

data/lib/json_schema_view.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "active_support"
+
+require_relative "json_schema_view/json_schema_definable"
+require_relative "json_schema_view/base_component"
+require_relative "json_schema_view/base_props"
+require_relative "json_schema_view/configuration"
+require_relative "json_schema_view/json_world_extensions"
+require_relative "json_schema_view/rails"
+require_relative "json_schema_view/renderers"
+require_relative "json_schema_view/schema_set"
+require_relative "json_schema_view/version"
+
+# A view library with JSON Schema.
+module JsonSchemaView
+  class << self
+    # @yield (see JsonSchemaView::Configuration.configure)
+    # @yieldparam (see JsonSchemaView::Configuration.configure)
+    def configure(&block)
+      Configuration.configure(&block)
+    end
+
+    # @return [JsonSchemaView::Configuration]
+    def configuration
+      Configuration.instance
+    end
+  end
+end

data/sig/json_schema_view.rbs

@@ -0,0 +1,4 @@
+module JsonSchemaView
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: json_schema_view
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomoya Chiba
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json_world
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A view library with JSON Schema
+email:
+- tomo.asleep@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".yardopts"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- json_schema_view.gemspec
+- lib/json_schema_view.rb
+- lib/json_schema_view/base_component.rb
+- lib/json_schema_view/base_props.rb
+- lib/json_schema_view/configuration.rb
+- lib/json_schema_view/configuration/schema_set_dictionary.rb
+- lib/json_schema_view/json_schema_definable.rb
+- lib/json_schema_view/json_world_extensions.rb
+- lib/json_schema_view/json_world_extensions/additional_properties.rb
+- lib/json_schema_view/json_world_extensions/any_of.rb
+- lib/json_schema_view/json_world_extensions/camelizable.rb
+- lib/json_schema_view/json_world_extensions/compact_optional_properties.rb
+- lib/json_schema_view/json_world_extensions/constant_property.rb
+- lib/json_schema_view/json_world_extensions/declarable.rb
+- lib/json_schema_view/json_world_extensions/enum_type.rb
+- lib/json_schema_view/json_world_extensions/map_type.rb
+- lib/json_schema_view/json_world_extensions/validatable.rb
+- lib/json_schema_view/rails.rb
+- lib/json_schema_view/rails/generators.rb
+- lib/json_schema_view/rails/generators/install/USAGE
+- lib/json_schema_view/rails/generators/install/install_generator.rb
+- lib/json_schema_view/rails/generators/install/templates/base_component.rb.tt
+- lib/json_schema_view/rails/generators/install/templates/base_props.rb.tt
+- lib/json_schema_view/rails/generators/install/templates/component_schema_set.rb.tt
+- lib/json_schema_view/rails/generators/install/templates/example/todo_item_resource.rb
+- lib/json_schema_view/rails/generators/install/templates/example/todo_list_component.rb
+- lib/json_schema_view/rails/generators/install/templates/initializer.rb.tt
+- lib/json_schema_view/rails/rails_engine.rb
+- lib/json_schema_view/rails/tasks/json_schema_component.rake
+- lib/json_schema_view/renderers.rb
+- lib/json_schema_view/renderers/base.rb
+- lib/json_schema_view/renderers/json.rb
+- lib/json_schema_view/renderers/react_on_rails.rb
+- lib/json_schema_view/schema_set.rb
+- lib/json_schema_view/schema_set/constant_search_helper.rb
+- lib/json_schema_view/version.rb
+- sig/json_schema_view.rbs
+homepage: https://github.com/increments/json_schema_view
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/increments/json_schema_view
+  source_code_uri: https://github.com/increments/json_schema_view
+  changelog_uri: https://github.com/increments/json_schema_view/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A view library with JSON Schema
+test_files: []