camille 0.6.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d5bb9ed1aaea6f00edbd04bf5d20a37d1a6f3cac39afc9a589e8e458f4c5363
-  data.tar.gz: c3e50816796af03af2b1be68cfaf635bb0ee6cc692451caadf927cc0f0f53b56
+  metadata.gz: 9cce4fa44ca836262ebc8da14ad045ee0b5ea2ce832fd6852e863280c04b6658
+  data.tar.gz: cfc0c1797ce19035efd81de11b1176154f50575b3d4a90834ef6de517ef1ea4b
 SHA512:
-  metadata.gz: d109a1064725e968ad7c89a5b0814ecb3e2f3ba58004c680d26548baaea3a0306e992511e51bc73a7856202a60749c50de342d56902cee722872f6803625f83e
-  data.tar.gz: 60bfc88c5b15e31ce42dbcff1f86cfe673c14c5510a5813b1900cdf76aa8cc58d590fdb85a618dd3ddcc65f75ff8ddd070f8150f3af0aa2e4988b2890c2dc498
+  metadata.gz: f502c8340be0ecb804982d811a35072188e7cb1fdc6602cc2c986cea94228caaae2d650d4379c3ba413299186bd8753befc51f6e6943d720384a841b876425f5
+  data.tar.gz: cf6fc100a3e11ade528d88d5fbe89451c37866a218b7ddb2c0b0fc18645b7ceb40dd393b813af80ac22908d545017fa6bfe74927010a67ce1fb4c35b7ff8928d

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 1.1.0
+
+### Added
+
+* Added support for HTTP verbs `put`, `patch` and `delete`.
+
+## 1.0.0
+
+### Changed
+
+* **[BREAKING]** Removed `Camille::Type#test` in favour of `Camille::Type#check`.
+* Decimal and DateTime types are no longer generated for installation.
+
 ## 0.6.4
 
 ### Changed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    camille (0.6.3)
+    camille (1.0.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.
@@ -29,10 +31,6 @@ Therefore, if the front-end requests the API by calling `data`, we have guarante
 
 By using these request functions, we also don't need to know about HTTP verbs and paths. It's impossible to have unrecognized routes, since Camille will make sure that each function handled by the correct Rails action.
 
-## Tutorial
-
-There's a step by step tutorial for setting up and showcasing Camille: https://github.com/onyxblade/camille-tutorial.
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -94,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
 
@@ -128,14 +126,15 @@ Each custom type is considered a type alias in TypeScript. And `alias_of` define
 type Product = {id: number, name: string}
 ```
 
-You can perform a type check on a value using `test`, which might be handy in testing:
+You can perform a type check on a value using `check`, which can be handy in testing:
 
 ```ruby
-error = Camille::Types::Product.test(hash)
-if error.nil?
+# `check` will return either a Camille::Checked or a Camille::TypeError
+result = Camille::Types::Product.check(hash)
+if result.checked?
   # the hash is accepted by Camille::Types::Product type
 else
-  p error
+  p result
 end
 ```
 
@@ -161,7 +160,7 @@ params(
   # an array of objects also works
   object_array: {
     field: Number
-  }[]
+  }[],
   # a union type is two types connected by '|'
   union: Number | String,
   # an intersection type is two types connected by '&'
@@ -264,6 +263,10 @@ object:
 
 Everything in `config/camille/types` and `config/camille/schemas` will automatically reload after changes in development environment, just like other files in Rails.
 
+## Versioning
+
+This project uses [Semantic Versioning](https://semver.org/).
+
 ## Development
 
 Run tests with `bundle exec rake`.

data/lib/camille/generators/install_generator.rb

@@ -10,15 +10,14 @@ module Camille
         copy_file "configuration.rb", "config/camille/configuration.rb"
       end
 
-      def create_date_time_and_decimal
-        copy_file "date_time.rb", "config/camille/types/date_time.rb"
-        copy_file "decimal.rb", "config/camille/types/decimal.rb"
-      end
-
       def create_schemas_folder
         copy_file ".keep", "config/camille/schemas/.keep"
       end
 
+      def create_types_folder
+        copy_file ".keep", "config/camille/types/.keep"
+      end
+
     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/type.rb

@@ -23,13 +23,8 @@ module Camille
       @underlying.check value
     end
 
-    def test value
-      result = check value
-      result.type_error? ? result : nil
-    end
-
-    def self.test value
-      new.test value
+    def self.check value
+      new.check value
     end
 
     def self.klass_name

data/lib/camille/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: camille
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 1.1.0
 platform: ruby
 authors:
 - merely
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -107,7 +106,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 +120,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: []