cecil 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25bc3ea619e4c5ed622fb086dbe51eeef561cbbfb733defad97dff14fd4ac0d5
-  data.tar.gz: 1b66b8d83ed649fc3be60789ce0909efd20707a939f8f8a3cd7b7abde5e5c6da
+  metadata.gz: b6d1ee8839362c15c74ec48e0ed9fef3a3f3f32a93fc56587a30e8018446e2fe
+  data.tar.gz: cc183f942739ef6db6a51cb934b62823cf19f0251f6fd5c423bde1042a03332d
 SHA512:
-  metadata.gz: 6370b9ec275ab1ecc3bfd03487088c89dc31f5c66dc53dc37de99eeda30968bd4ff39c020d4839df318aa302be4ad1e9dcbb843b7f224e34b9352a37f2f6c8f9
-  data.tar.gz: 2dcb0a27ffdeef5271df1e222b80dc37908d9226a13b19e8e9427e1f73b85933736b5358e758501982aead5f9341f294e6ac6a9bc5ad4cec1d738bc4d171c5d9
+  metadata.gz: 2776e0ca696392d5a61bd9dbb306105ae64eee0a5371b7e1919a6b3c0a30128a223d39460e81fa0f0a7941231942792ac4578741db0bb37c7d7d8bcc582eba40
+  data.tar.gz: 73c04db6ba020b0e3494e28aac514fdc4ad913161fd9efb80a67a1acd76220ec4d1785175d2bb1f505ffdb6081589dd450f8ecb81e2c429ba009db9e90705bb4

data/.yard/README.md

@@ -139,7 +139,7 @@ class User extends Model {
 
 ### Emit source code to other locations
 
-When generating source code, things like functions, parameters, classes, etc, often need to be declared, imported, or otherwise setup or before being used.
+When generating source code, things like functions, parameters, classes, etc, often need to be declared, imported, or otherwise setup before being used.
 
 `content_for` can be used to add content to a different location of your file.
 
@@ -360,7 +360,7 @@ See: {Cecil::BlockContext Methods available inside a Cecil block}
     # })()
     ```
 - {Cecil::BlockContext#content_for `#content_for`} emits source code to different locations
-- {Cecil::BlockContext#defer `#defer`} for waits to emit the given source until after data has been gathered
+- {Cecil::BlockContext#defer `#defer`} waits to emit the given source until after data has been gathered
 
 ### Customizing behavior for the language of the source code you're generating
 
@@ -372,6 +372,7 @@ Many of Cecil's defaults can be customized by creating a subclass of {Cecil::Cod
 Currently, Cecil comes with:
 - {Cecil::Code `Cecil::Code`} for generic code
 - {Cecil::Lang::TypeScript `Cecil::Lang::TypeScript`} for JavaScript and TypeScript
+- {Cecil::Lang::Rust `Cecil::Lang::Rust`} for Rust
 
 
 ### Auto-closing brackets
@@ -409,7 +410,7 @@ becomes
 ```javascript
 user = ([{
     id: 42
-)}]
+}])
 ```
 
 Currently, the algorithm is simplistic, so open brackets that aren't at the end of the string will *not* get closed.
@@ -419,7 +420,7 @@ In this example, the `(` in `test(` needs to be closed manually:
 ```ruby
 `test("getter $fn", () => {`[fn: 'getUsername'] do
   `assert(false)`
-end << `)'
+end << `)`
 ```
 
 ```javascript
@@ -432,12 +433,12 @@ test("getter getUsername", () => {
 
 Default placeholder rules:
 - start with `$`-- e.g. `$foo`
-- named with alpha-numeric and underscore -- e.g. `$foo_bar123`
-- names can optionally be surrounded by optional brackets -- e.g  `${my_placeholder}`
+- named can contain alpha-numeric and underscore characters-- e.g. `$foo_bar123`
+- names can optionally be surrounded by brackets -- e.g  `${my_placeholder}`, `$[my_placeholder]`, `$<my_placeholder>`, or `$(my_placeholder)`
 
 Surrounding with brackets can be useful to separate a placeholder from subsequent characters that would otherwise get parsed as a placeholder.
 
-E.g. `function ${fn}Sync()`-- without curly brackets, the placeholder would be parsed as `fnSync`.
+E.g. `function ${fn}Sync()`-- without curly brackets `$fnSync` would be the placeholder.
 
 Customize placeholder syntax by subclassing {Cecil::Code `Cecil::Code`}
 and overriding {Cecil::Code placeholder-related methods}.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cecil (0.1.3)
+    cecil (0.1.5)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -139,7 +139,7 @@ class User extends Model {
 
 ### Emit source code to other locations
 
-When generating source code, things like functions, parameters, classes, etc, often need to be declared, imported, or otherwise setup or before being used.
+When generating source code, things like functions, parameters, classes, etc, often need to be declared, imported, or otherwise setup before being used.
 
 `content_for` can be used to add content to a different location of your file.
 
@@ -360,7 +360,7 @@ See: [Methods available inside a Cecil block][{BlockContext}]
     # })()
     ```
 - [`#content_for`][{BlockContext#content_for}] emits source code to different locations
-- [`#defer`][{BlockContext#defer}] for waits to emit the given source until after data has been gathered
+- [`#defer`][{BlockContext#defer}] waits to emit the given source until after data has been gathered
 
 ### Customizing behavior for the language of the source code you're generating
 
@@ -372,6 +372,7 @@ Many of Cecil's defaults can be customized by creating a subclass of [`Cecil::Co
 Currently, Cecil comes with:
 - [`Cecil::Code`][{Code}] for generic code
 - [`Cecil::Lang::TypeScript`][{Lang::TypeScript}] for JavaScript and TypeScript
+- [`Cecil::Lang::Rust`][{Lang::Rust}] for Rust
 
 
 ### Auto-closing brackets
@@ -409,7 +410,7 @@ becomes
 ```javascript
 user = ([{
     id: 42
-)}]
+}])
 ```
 
 Currently, the algorithm is simplistic, so open brackets that aren't at the end of the string will *not* get closed.
@@ -419,7 +420,7 @@ In this example, the `(` in `test(` needs to be closed manually:
 ```ruby
 `test("getter $fn", () => {`[fn: 'getUsername'] do
   `assert(false)`
-end << `)'
+end << `)`
 ```
 
 ```javascript
@@ -432,12 +433,12 @@ test("getter getUsername", () => {
 
 Default placeholder rules:
 - start with `$`-- e.g. `$foo`
-- named with alpha-numeric and underscore -- e.g. `$foo_bar123`
-- names can optionally be surrounded by optional brackets -- e.g  `${my_placeholder}`
+- named can contain alpha-numeric and underscore characters-- e.g. `$foo_bar123`
+- names can optionally be surrounded by brackets -- e.g  `${my_placeholder}`, `$[my_placeholder]`, `$<my_placeholder>`, or `$(my_placeholder)`
 
 Surrounding with brackets can be useful to separate a placeholder from subsequent characters that would otherwise get parsed as a placeholder.
 
-E.g. `function ${fn}Sync()`-- without curly brackets, the placeholder would be parsed as `fnSync`.
+E.g. `function ${fn}Sync()`-- without curly brackets `$fnSync` would be the placeholder.
 
 Customize placeholder syntax by subclassing [`Cecil::Code`][{Code}]
 and overriding [placeholder-related methods][{Code}].

data/lib/cecil/lang/rust.rb

@@ -0,0 +1,91 @@
+require_relative "../../cecil"
+
+module Cecil
+  module Lang
+    class Rust < Code
+      # Overrides to use 4 spaces for indentation
+      def indent_chars = "    "
+
+      # Overrides to ignore ambiguous indentation
+      def handle_ambiguous_indentation = Cecil::Indentation::Ambiguity.ignore
+
+      module Helpers
+        # Short for "list"; Accepts one or a list of strings and returns them joined with `", "`
+        #
+        # @param items [Array[#to_s], #to_s] One or a list of objects that respond to `#to_s`
+        # @return [String] The stringified inputs concatenated with `", "`
+        def l(items) = Array(items).compact.join(", ")
+
+        # Escapes codepoint as unicode character literal
+        # See https://doc.rust-lang.org/reference/tokens.html#unicode-escapes
+        def unicode_escape_codepoint(char_int) = "\\u{#{char_int.to_s(16)}}"
+
+        # Escapes string as unicode character literals
+        def unicode_escape(str) = str.each_codepoint.map { unicode_escape_codepoint(_1) }.join
+
+        # According to https://doc.rust-lang.org/reference/tokens.html#ascii-escapes
+        CHAR_TO_CUSTOM_ESCAPE_LITERAL = {
+          "\n" => '\n',
+          "\r" => '\r',
+          "\t" => '\t',
+          "\0" => '\0',
+          "\\" => "\\\\", # \ => \\
+          '"' => '\\"'    # " => \"
+        }.freeze
+
+        # Escapes a character (string with one character) for use in a Rust string literal.
+        #
+        # @example
+        #   rchar("\n") # => \n
+        #   rchar('"')  # => \"
+        #   rchar('😉') # => \u{1f609}
+        def rchar(char)
+          CHAR_TO_CUSTOM_ESCAPE_LITERAL[char] ||
+            case char
+            when /^[ -~]$/ then char
+            else unicode_escape(char)
+            end
+        end
+
+        # Short for "string content"; returns escaped version of the string that can be inserted into a
+        # string literal.
+        #
+        # Useful for inserting data into a string or for outputting a string but using quotes to make it clear to the
+        # reader what the intended output will be.
+        #
+        # @example Inserting into a string literal
+        #   name = %q{Bob "the Machine" O'Brian}
+        #   `let admin = "$name (Admin)";`[s name]
+        #
+        #   # outputs:
+        #   # let admin = "Bob \"the Machine\" O\'Brian (Admin)";
+        #
+        # @param val [#to_s] A string or any object that responds to `#to_s`
+        # @return [String] A JSON string without quotes
+        def s(val) = val.each_char.map { rchar(_1) }.join
+
+        # short for "rust value"; returns a Rust literal version of the input.
+        #
+        # Currently handles strings, integers, floats, and booleans.
+        #
+        # @example
+        #   `let name = $name;`[rs "Bob \"the Machine\" O\'Brian (Admin)"]
+        #   `let age = $age;`[rs 42]
+        #   `let friendliness = $friendliness;`[rs 9.9]
+        #   `let is_admin = $is_admin;`[rs true]
+        #
+        #   # outputs:
+        #   # let name = "Bob \"the Machine\" O\'Brian (Admin)";
+        #   # let age = 42;
+        #   # let friendliness = 9.9;
+        #   # let is_admin = true;
+        def rs(val)
+          case val
+          in String then %("#{s val}")
+          in Integer | Float | true | false then val.to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cecil/node.rb

@@ -357,6 +357,15 @@ module Cecil
       def self.build(src:, builder:, **kwargs)
         placeholders = builder.syntax.scan_for_placeholders(src)
 
+        # HACK: to make sure we throw the exception at the time the developer adds the string/template
+        #
+        # This gets called later, too, so it's work being done twice.
+        #
+        # This should probably be refactored so that Nodes carry around a de-indented version, and then just have to add
+        # the indentation later when stringified
+        Indentation.reindent(src, 0, "THIS SHOULD NEVER BE USED",
+                             handle_ambiguity: builder.syntax.handle_ambiguous_indentation)
+
         if placeholders.any?
           new(src:, placeholders:, **kwargs)
         else
@@ -375,7 +384,7 @@ module Cecil
       def with(*positional_values, **named_values, &)
         src =
           case [positional_values, named_values, @placeholders]
-          in [], {}, []
+          in [], {}, [] # TODO: is this case possible? should it be?
             @src
           in [], _, _
             Text.interpolate_named(@src, @placeholders, named_values)

data/lib/cecil/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cecil
-  VERSION = "0.1.3"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cecil
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Mike Nicholaides
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-22 00:00:00.000000000 Z
+date: 2024-03-24 00:00:00.000000000 Z
 dependencies: []
 description: |
   An experimental templating library designed specifically for generating source code (especially for languages that
@@ -36,6 +36,7 @@ files:
 - lib/cecil/code.rb
 - lib/cecil/content_for.rb
 - lib/cecil/indentation.rb
+- lib/cecil/lang/rust.rb
 - lib/cecil/lang/typescript.rb
 - lib/cecil/node.rb
 - lib/cecil/placeholder.rb