camille 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1ea493a56729858449f5d04a2242a0920a1aff7e345fde52d7fed3061b9cb3e
-  data.tar.gz: 624ef2a41e1c413e8e288de97f6b464f02ce51d9f2cda9eeed9b7ba4a818aaad
+  metadata.gz: 82a091b46cd7266990fb540e54febefd78773260f780283d624fa88321090d81
+  data.tar.gz: 33a660f689f967f3be04e9bc70b15214fa28d36c74df223357f66dbe17bce7b1
 SHA512:
-  metadata.gz: 3bf2d9199a22c3a1a6f0c81538d93e87f4aacf073c52866fed0d07156f44af98d059c6559071554e275dc754bfd5413284acebf841e59f11659acfa9527827bc
-  data.tar.gz: 8b249d54deee18c77faebe8da95eda1ff6bae624daf67f9db1e54225951fca9259c5ef58f0c22393806ec5225c007f6962cdb377eff572a2bc20c97bb5c48859
+  metadata.gz: 32442ecdc91cd62092d3d49ce67c6cfe2ccedaeb1a285a1e6f44615792ce9408d8d245690cb96ff269853a72d3807080f1bdcb88639439b4e957a4d8ced726f4
+  data.tar.gz: 21398e4687f2a7e3f56b06b86ad1c86a80bbe8719c57227a413df09ad7251c28e86af89145b9656243d80c68b9eeb4a9dea412b1a6e67c6189cc6b55d2af943f

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 1.2.0
+
+### Added
+
+* Added `TypeLiteralGenerator` and `SchemaLiteralGenerator` to allow partial endpoint generation with `CodeGenerator`.
+
+## 1.1.0
+
+### Added
+
+* Added support for HTTP verbs `put`, `patch` and `delete`.
+
 ## 1.0.0
 
 ### Changed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    camille (0.6.4)
+    camille (1.1.0)
       rails (>= 6.1, < 8.1)
 
 GEM
@@ -108,6 +108,7 @@ GEM
       net-smtp
     marcel (1.0.4)
     mini_mime (1.1.5)
+    mini_portile2 (2.8.9)
     minitest (5.25.4)
     net-imap (0.5.6)
       date
@@ -119,6 +120,9 @@ GEM
     net-smtp (0.5.1)
       net-protocol
     nio4r (2.7.4)
+    nokogiri (1.17.2)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
     nokogiri (1.17.2-x86_64-linux)
       racc (~> 1.4)
     psych (5.2.1)
@@ -210,4 +214,4 @@ DEPENDENCIES
   rspec-rails
 
 BUNDLED WITH
-   2.2.33
+   2.7.2

data/README.md

@@ -1,5 +1,7 @@
 # Camille
 
+![Gem Version](https://img.shields.io/gem/v/camille)
+
 ## Why?
 
 Traditionally, the JSON response from a Rails API server isn't typed. So even if we have TypeScript at the front-end, we still have little guarantee that our back-end would return the correct type and structure of data.
@@ -90,7 +92,7 @@ The `params` type for an endpoint is required to be an object type, or a hash in
 
 Camille will automatically add a Rails route for each endpoint. You don't need to do anything other than having the schema file in place.
 
-When defining an endpoint, you can also use `post` instead of `get` for non-idempotent requests. However, no other HTTP verbs are supported, because verbs in RESTful like `patch` and `delete` indicate what we do on resources, but in RPC-style design each request is merely a function call that does not concern RESTful resources.
+When defining an endpoint, you can use any of `get`, `post`, `put`, `patch`, or `delete`.
 
 ### Custom types
 

data/lib/camille/code_generator.rb

@@ -1,21 +1,38 @@
 require 'stringio'
 
 module Camille
-  module CodeGenerator
-    def self.generate_ts
+  class CodeGenerator
+    def initialize types_literal_lines: Camille::Types.literal_lines, schemas_literal_lines: Camille::Schemas.literal_lines
+      @types_literal_lines = types_literal_lines
+      @schemas_literal_lines = schemas_literal_lines
+    end
+
+    def generate_ts
       io = StringIO.new
-      io.puts Camille::Configuration.ts_header
-      io.puts
-      Camille::Types.literal_lines.each do |line|
-        io.puts "export #{line}"
-      end
-      io.puts
-      io.print "export default "
-      Camille::Schemas.literal_lines.each do |line|
-        io.puts line
-      end
+      generate_header io
+      generate_types io
+      generate_schemas io
       io.string
     end
 
+    private
+      def generate_header io
+        io.puts Camille::Configuration.ts_header
+        io.puts
+      end
+
+      def generate_types io
+        @types_literal_lines.each do |line|
+          io.puts "export #{line}"
+        end
+        io.puts
+      end
+
+      def generate_schemas io
+        io.print "export default "
+        @schemas_literal_lines.each do |line|
+          io.puts line
+        end
+      end
   end
 end

data/lib/camille/main_controller.rb

@@ -4,7 +4,7 @@ module Camille
   class MainController < ActionController::Base
     def endpoints_ts
       Camille::Loader.check_and_raise_exception
-      render plain: Camille::CodeGenerator.generate_ts
+      render plain: Camille::CodeGenerator.new.generate_ts
     end
   end
 end

data/lib/camille/schema.rb

@@ -46,5 +46,17 @@ module Camille
       def self.post name, &block
         define_endpoint :post, name, &block
       end
+
+      def self.put name, &block
+        define_endpoint :put, name, &block
+      end
+
+      def self.patch name, &block
+        define_endpoint :patch, name, &block
+      end
+
+      def self.delete name, &block
+        define_endpoint :delete, name, &block
+      end
   end
-end
+end

data/lib/camille/schema_literal_generator.rb

@@ -0,0 +1,51 @@
+module Camille
+  class SchemaLiteralGenerator
+    def initialize schemas
+      @schemas = schemas
+    end
+
+    def literal_lines
+      [
+        Camille::Line.new('{'),
+        tree_literal_lines(namespace_tree).map(&:do_indent),
+        Camille::Line.new('}')
+      ]
+    end
+
+    private
+      def namespace_tree
+        tree = {}
+
+        @schemas.sort_by(&:klass_name).each do |s|
+          path = s.klass_name.split('::')
+          *namespaces, schema_name = path
+
+          level = namespaces.inject(tree) do |level, namespace|
+            level[namespace] ||= {}
+            level[namespace]
+          end
+
+          level[schema_name] = s
+        end
+
+        tree
+      end
+
+      def tree_literal_lines tree
+        tree.map do |key, value|
+          if value.is_a? ::Hash
+            [
+              Camille::Line.new("#{Camille::Configuration.response_key_converter.call(key.to_s)}: {"),
+              tree_literal_lines(value).map(&:do_indent),
+              Camille::Line.new('},')
+            ]
+          else
+            value.literal_lines.tap do |lines|
+              lines.first.prepend("#{Camille::Configuration.response_key_converter.call(key.to_s)}: ")
+              lines.last.append(',')
+            end
+          end
+        end.flatten
+      end
+  end
+end

data/lib/camille/schemas.rb

@@ -1,47 +1,7 @@
 module Camille
   module Schemas
     def self.literal_lines
-      [
-        Camille::Line.new('{'),
-        tree_literal_lines(namespace_tree).map(&:do_indent),
-        Camille::Line.new('}')
-      ]
+      Camille::SchemaLiteralGenerator.new(Camille::Loader.loaded_schemas).literal_lines
     end
-
-    private
-      def self.namespace_tree
-        tree = {}
-
-        Camille::Loader.loaded_schemas.sort_by(&:klass_name).each do |s|
-          path = s.klass_name.split('::')
-          *namespaces, schema_name = path
-
-          level = namespaces.inject(tree) do |level, namespace|
-            level[namespace] ||= {}
-            level[namespace]
-          end
-
-          level[schema_name] = s
-        end
-
-        tree
-      end
-
-      def self.tree_literal_lines tree
-        tree.map do |key, value|
-          if value.is_a? ::Hash
-            [
-              Camille::Line.new("#{Camille::Configuration.response_key_converter.call(key.to_s)}: {"),
-              tree_literal_lines(value).map(&:do_indent),
-              Camille::Line.new('},')
-            ]
-          else
-            value.literal_lines.tap do |lines|
-              lines.first.prepend("#{Camille::Configuration.response_key_converter.call(key.to_s)}: ")
-              lines.last.append(',')
-            end
-          end
-        end.flatten
-      end
   end
 end

data/lib/camille/type_literal_generator.rb

@@ -0,0 +1,14 @@
+module Camille
+  class TypeLiteralGenerator
+    def initialize types
+      @types = types
+    end
+
+    def literal_lines
+      @types.sort_by(&:klass_name).map do |type|
+        instance = type.new
+        Camille::Line.new("type #{instance.literal} = #{instance.underlying.literal}")
+      end
+    end
+  end
+end

data/lib/camille/types.rb

@@ -1,10 +1,7 @@
 module Camille
   module Types
     def self.literal_lines
-      Camille::Loader.loaded_types.sort_by(&:klass_name).map do |type|
-        instance = type.new
-        Camille::Line.new("type #{instance.literal} = #{instance.underlying.literal}")
-      end
+      Camille::TypeLiteralGenerator.new(Camille::Loader.loaded_types).literal_lines
     end
   end
 end

data/lib/camille/version.rb

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

data/lib/camille.rb

@@ -40,6 +40,8 @@ require_relative "camille/railtie"
 require_relative "camille/controller"
 require_relative "camille/loader"
 require_relative "camille/configuration"
+require_relative "camille/type_literal_generator"
+require_relative "camille/schema_literal_generator"
 require_relative "camille/code_generator"
 require_relative "camille/main_controller"
 require_relative "camille/key_converter"
@@ -57,6 +59,6 @@ module Camille
   end
 
   def self.generate_ts
-    Camille::CodeGenerator.generate_ts
+    Camille::CodeGenerator.new.generate_ts
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: camille
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - merely
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-19 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -77,11 +76,13 @@ files:
 - lib/camille/railtie.rb
 - lib/camille/rendered.rb
 - lib/camille/schema.rb
+- lib/camille/schema_literal_generator.rb
 - lib/camille/schemas.rb
 - lib/camille/syntax.rb
 - lib/camille/type.rb
 - lib/camille/type_error.rb
 - lib/camille/type_error_printer.rb
+- lib/camille/type_literal_generator.rb
 - lib/camille/types.rb
 - lib/camille/types/any.rb
 - lib/camille/types/array.rb
@@ -107,7 +108,6 @@ licenses:
 metadata:
   homepage_uri: https://github.com/onyxblade/camille
   source_code_uri: https://github.com/onyxblade/camille
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -122,8 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Typed API schema for Rails with TypeScript codegen
 test_files: []