camille 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5911a8f4d1519a2a373ebee118bce4f110d64f5eaeafece5c8c8e46580b5c20
-  data.tar.gz: b59a4600bd145350d1217219b0074ffb6e80d8cdc97318995b6ba2b0bffe7450
+  metadata.gz: 5779c76d0ca3c695e1e15d0870d94be5739449f7ad1b9422ab9944d139f3a6d1
+  data.tar.gz: 855906b19324060e4fb8578451e1fd77f692918f6722a81b9f3fbdc5cbf48fd3
 SHA512:
-  metadata.gz: 3088068a948ca92e1a6bc90690c5f27d5e2c788c3f76e2ba40b5ebf62b7c3fdffac809411941a3f05a77ace636ce16bf7742c12c1ae5700c4b45d7bfb9fdddfb
-  data.tar.gz: c6f0a0b72216805bf591bc4289172e69382f702ccc14d161a3b63267dc83816a47045e9d61884029349543aac5ecf5aeb43bbc82f0c95ef23ff7df569037b8b6
+  metadata.gz: e555aebf740ecd06dcf96928a3aeafe414430a7d439a83679da90d2e60e23a97cd28bc583a473ddab76c60275e31668b76f9220ca2278c21ecceb8f2f11743fa
+  data.tar.gz: 00bf823aa9f394c1198cd492f42cd716b8bd59c08fe7e704df64aa92cdb927198ad87761f867de9b59153cba96490190292296755ef1642bd9c759820b00ecc0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    camille (0.1.0)
+    camille (0.3.0)
       rails (>= 6.1, < 8)
 
 GEM

data/lib/camille/generators/install_generator.rb

@@ -0,0 +1,23 @@
+
+module Camille
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      desc 'install camille'
+
+      def copy_configuration_file
+        copy_file "configuration.rb", "config/camille/configuration.rb"
+      end
+
+      def copy_type_example
+        copy_file "type_example.rb", "config/camille/types/example.rb"
+      end
+
+      def copy_schema_example
+        copy_file "schema_example.rb", "config/camille/schemas/examples.rb"
+      end
+
+    end
+  end
+end

data/lib/camille/generators/schema_generator.rb

@@ -0,0 +1,14 @@
+
+module Camille
+  module Generators
+    class SchemaGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      desc 'generate camille schema'
+
+      def generate_type_file
+        template 'schema_template.erb', "config/camille/schemas/#{@name}.rb"
+      end
+    end
+  end
+end

data/lib/camille/generators/templates/configuration.rb

@@ -0,0 +1,6 @@
+Camille.configure do |config|
+  # Contents to be placed at the beginning of the output TypeScript file.
+  config.ts_header = <<~EOF
+    import request from './request'
+  EOF
+end

data/lib/camille/generators/templates/schema_example.rb

@@ -0,0 +1,35 @@
+using Camille::CoreExt
+
+class Camille::Schemas::Examples < Camille::Schema
+  include Camille::Types
+
+  get :find do
+    params(
+      id: Number
+    )
+
+    response(
+      example?: Example
+    )
+  end
+
+  get :list do
+    response(
+      examples: Example[]
+    )
+  end
+
+  post :update do
+    params(
+      id: Number,
+      example: Example
+    )
+
+    response(
+      success: Boolean,
+      errors: {
+        message: String
+      }[]
+    )
+  end
+end

data/lib/camille/generators/templates/schema_template.erb

@@ -0,0 +1,14 @@
+using Camille::CoreExt
+
+class Camille::Schemas::<%= class_name %> < Camille::Schema
+  include Camille::Types
+
+  # get :data do
+  #   params(
+  #     id: Number
+  #   )
+  #   response(
+  #     name: String
+  #   )
+  # end
+end

data/lib/camille/generators/templates/type_example.rb

@@ -0,0 +1,10 @@
+using Camille::CoreExt
+
+class Camille::Types::Example < Camille::Type
+  include Camille::Types
+
+  alias_of(
+    id: Number,
+    name: String,
+  )
+end

data/lib/camille/generators/templates/type_template.erb

@@ -0,0 +1,9 @@
+using Camille::CoreExt
+
+class Camille::Types::<%= class_name %> < Camille::Type
+  include Camille::Types
+
+  alias_of(
+    # id: Number
+  )
+end

data/lib/camille/generators/type_generator.rb

@@ -0,0 +1,14 @@
+
+module Camille
+  module Generators
+    class TypeGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      desc 'generate camille type'
+
+      def generate_type_file
+        template 'type_template.erb', "config/camille/types/#{@name}.rb"
+      end
+    end
+  end
+end

data/lib/camille/loader.rb

@@ -10,8 +10,25 @@ module Camille
         synchronize do
           loader = Zeitwerk::Loader.new
           loader.enable_reloading if !app.config.cache_classes
-          loader.push_dir "#{app.root}/config/camille/types", namespace: Camille::Types
-          loader.push_dir "#{app.root}/config/camille/schemas", namespace: Camille::Schemas
+
+          types_dir = "#{app.root}/config/camille/types"
+          schemas_dir = "#{app.root}/config/camille/schemas"
+
+          if Dir.exist? types_dir
+            loader.push_dir types_dir, namespace: Camille::Types
+          else
+            unless inside_generator?
+              puts "[Camille Warning] Expected folder `config/camille/types`. Run `rails g camille:install` to fix it."
+            end
+          end
+
+          if Dir.exist? schemas_dir
+            loader.push_dir schemas_dir, namespace: Camille::Schemas
+          else
+            unless inside_generator?
+              puts "[Camille Warning] Expected folder `config/camille/schemas`. Run `rails g camille:install` to fix it."
+            end
+          end
 
           loader.setup
           @zeitwerk_loader = loader
@@ -22,17 +39,6 @@ module Camille
         end
       end
 
-      def eager_load
-        @eager_loading = true
-        load @configuration_location
-        @zeitwerk_loader.eager_load
-        @eager_loading = false
-      end
-
-      def eager_loading?
-        @eager_loading
-      end
-
       def reload_types_and_schemas
         synchronize do
           Camille::Loader.loaded_types.clear
@@ -69,22 +75,32 @@ module Camille
         end
       end
 
-      def construct_controller_name_to_schema_map
-        synchronize do
-          controller_name_to_schema_map.clear
-          loaded_schemas.each do |schema|
-            controller_class_name = "#{schema.klass_name}Controller"
-            controller_name_to_schema_map[controller_class_name] = schema
+      private
+        def eager_load
+          if File.exist?(@configuration_location)
+            load @configuration_location
+          else
+            unless inside_generator?
+              puts "[Camille Warning] Expected file `config/camille/configuration.rb`. Run `rails g camille:install` to fix it."
+            end
           end
+          @zeitwerk_loader.eager_load
         end
-      end
 
-      def reload
-        synchronize do
-          reload_types_and_schemas
-          Rails.application.reload_routes!
+        def construct_controller_name_to_schema_map
+          synchronize do
+            controller_name_to_schema_map.clear
+            loaded_schemas.each do |schema|
+              controller_class_name = "#{schema.klass_name}Controller"
+              controller_name_to_schema_map[controller_class_name] = schema
+            end
+          end
+        end
+
+        def inside_generator?
+          # https://stackoverflow.com/a/53963584
+          !(Rails.const_defined?(:Server) || Rails.const_defined?(:Console))
         end
-      end
 
     end
 

data/lib/camille/main_controller.rb

@@ -3,11 +3,7 @@ require 'action_controller'
 module Camille
   class MainController < ActionController::Base
     def endpoints_ts
-      if Rails.env.development?
-        render plain: Camille::CodeGenerator.generate_ts
-      else
-        head 404
-      end
+      render plain: Camille::CodeGenerator.generate_ts
     end
   end
 end

data/lib/camille/railtie.rb

@@ -10,14 +10,17 @@ module Camille
       Camille::Loader.setup_zeitwerk_loader(app)
 
       app.routes.prepend do
-        get '/camille/endpoints.ts' => 'camille/main#endpoints_ts'
+        if Rails.env.development?
+          get '/camille/endpoints.ts' => 'camille/main#endpoints_ts'
+        end
+
         Camille::Loader.register_routes(self)
       end
 
       dir = "#{Rails.root}/config/camille"
 
       update_checker = ActiveSupport::FileUpdateChecker.new([], {dir => ['rb']}) do
-        Camille::Loader.reload
+        Camille::Loader.reload_types_and_schemas
       end
 
       app.reloaders << update_checker

data/lib/camille/schema.rb

@@ -2,20 +2,10 @@ module Camille
   class Schema
     class AlreadyDefinedError < ::ArgumentError; end
 
-    include Camille::Types
-
     def self.endpoints
       @endpoints ||= {}
     end
 
-    def self.const_missing name
-      if Camille::Loader.eager_loading?
-        Camille::Types.const_get(name)
-      else
-        super
-      end
-    end
-
     def self.path
       "/#{ActiveSupport::Inflector.underscore klass_name}"
     end

data/lib/camille/type.rb

@@ -2,7 +2,6 @@ module Camille
   # This class represents all custom types defined by the user.
   class Type < BasicType
     class NotImplementedError < ::NotImplementedError; end
-    include Camille::Types
 
     attr_reader :underlying
 
@@ -30,14 +29,6 @@ module Camille
       self.class.klass_name.gsub(/::/, '_')
     end
 
-    def self.const_missing name
-      if Camille::Loader.eager_loading?
-        Camille::Types.const_get(name)
-      else
-        super
-      end
-    end
-
     def self.inherited klass
       Camille::Loader.loaded_types << klass
     end

data/lib/camille/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Camille
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/camille.rb

@@ -30,6 +30,11 @@ require_relative "camille/configuration"
 require_relative "camille/code_generator"
 require_relative "camille/main_controller"
 
+require "rails/generators"
+require_relative "camille/generators/install_generator"
+require_relative "camille/generators/type_generator"
+require_relative "camille/generators/schema_generator"
+
 module Camille
   class Error < StandardError; end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: camille
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - 辻彩
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-14 00:00:00.000000000 Z
+date: 2023-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -51,6 +51,14 @@ files:
 - lib/camille/controller_extension.rb
 - lib/camille/core_ext.rb
 - lib/camille/endpoint.rb
+- lib/camille/generators/install_generator.rb
+- lib/camille/generators/schema_generator.rb
+- lib/camille/generators/templates/configuration.rb
+- lib/camille/generators/templates/schema_example.rb
+- lib/camille/generators/templates/schema_template.erb
+- lib/camille/generators/templates/type_example.rb
+- lib/camille/generators/templates/type_template.erb
+- lib/camille/generators/type_generator.rb
 - lib/camille/line.rb
 - lib/camille/loader.rb
 - lib/camille/main_controller.rb