super_template 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7208b9c0dea29c3eec75b4a4259c93d4c690d3c2ddcc3364e5b06dbda420552c
+  data.tar.gz: b1aa10783c8e29874a280c9f637ad50278b24951fdb5285598ff4cd366d53bf9
+SHA512:
+  metadata.gz: 026126cc765646c81692b5af1f6b7089d1aa86c160527d67064d5795de015a47f084a284cc152671b036abc4dc32805c74caa13c7ea0495852e3a4150a5d31fb
+  data.tar.gz: fe490f46b1d804f73950728c6310a7722226b73a2c02541eeae6ec01904cf0ec8504f980af931fb1588d6b7ea98210e9bf3d4abe2df5a531841bab519e59d3c3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 Chongchen Chen
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,142 @@
+# [WIP]Super Template
+
+This library not only can be used to generate sql, but also designed as a general template library.
+
+Maintain your raw SQL logic in rails with plain old ruby object.
+
+Every sql template is reusable, you don't need to write similar SQL logic again and again!
+
+Inspired by [ViewComponent](https://viewcomponent.org/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "super_template"
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install super_template
+```
+
+## Quick start
+
+A SuperTemplate is a Ruby object.
+
+Templates are subclasses of `SuperTemplate::Base` and live in `app/sqls`.
+
+Use the template generator to create a new Sql Template.
+
+The generator accepts a folder name, template name and a list of arguments:
+
+```bash
+$ bin/rails generate component MySqlTemplate limit
+
+    invoke  test_unit
+    create  test/sqls/my_sql_template_test.rb
+    create  app/sqls/my_sql_template.rb
+    create  app/sqls/my_sql_template.sql.erb
+```
+
+If you want to generate files in another folder. you can execute:
+
+```bash
+$ bin/rails generate component MySqlTemplate limit --dir another_folder
+
+    invoke  test_unit
+    create  test/another_folder/my_sql_template_test.rb
+    create  app/another_folder/my_sql_template.rb
+    create  app/another_folder/my_sql_template.sql.erb
+```
+
+Template can be instantiated and passed to Rails' connection execute method:
+
+```ruby
+ActiveRecord::Base.connection.execute(MySqlTemplate.new(limit: 10).call, {name: "dummy"})
+```
+
+## Implementation
+
+### ActiveReocrd or Arel mode
+
+Edit file `app/sqls/my_sql_template.rb`
+
+```ruby
+class MySqlTemplate < SuperTemplate::Base
+
+    def initialize(limit:)
+        @limit = limit
+    end
+
+    def render_template
+        MyTable.limit(@limit).all.to_sql
+    end
+end
+```
+
+
+### Inline style
+
+Edit file `app/sqls/my_sql_template.rb`
+
+```ruby
+class MySqlTemplate < SuperTemplate::Base
+    erb_template <<-ERB
+        SELECT * FROM my_table WHERE col = :name limit <%= @limit %>
+    ERB
+
+    def initialize(limit:)
+        @limit = limit
+    end
+end
+```
+
+### Template File
+
+Edit file `app/sqls/my_sql_template.html.erb`
+
+```erb
+SELECT * FROM my_table WHERE col = :name limit <%= @limit %>
+```
+
+Edit file `app/sqls/my_sql_template.rb`
+
+```ruby
+class MySqlTemplate < SuperTemplate::Base
+    def initialize(limit:)
+        @limit = limit
+    end
+end
+```
+
+## Call Super
+Edit file `app/sqls/sub_sql_template.rb`
+
+```ruby
+class SubSqlTemplate < SuperTemplate::Base
+    def initialize(limit:, offset:)
+        super(limit: limit)
+        @offset = offset
+    end
+    template :erb, <<~ERB
+    <%= super %> limit <%= @offset %>
+    ERB
+end
+```
+
+## Contributing
+
+Contribution directions go here.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/generators/super_template/abstract_generator.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module SuperTemplate
+  module Generators
+    module AbstractGenerator
+      def copy_view_file
+        template "component.#{options["format"]}.#{engine_name}", destination unless options["inline"]
+      end
+
+      private
+
+      def destination
+        File.join(destination_directory, "#{destination_file_name}.#{options["format"]}.#{engine_name}")
+      end
+
+      def destination_directory
+        if sidecar?
+          File.join(template_path, class_path, destination_file_name)
+        else
+          File.join(template_path, class_path)
+        end
+      end
+
+      def destination_file_name
+        "#{file_name}_template"
+      end
+
+      def file_name
+        @_file_name ||= super.sub(/_template\z/i, "")
+      end
+
+      def template_path
+        "app/templates"
+      end
+
+      def sidecar?
+        options["sidecar"]
+      end
+    end
+  end
+end

data/lib/generators/super_template/template/template_generator.rb

@@ -0,0 +1,58 @@
+require_relative "../abstract_generator"
+module SuperTemplate
+  module Generators
+    class TemplateGenerator < Rails::Generators::NamedBase
+
+      include SuperTemplate::Generators::AbstractGenerator
+
+      source_root File.expand_path("templates", __dir__)
+
+      argument :attributes, type: :array, default: [], banner: "attribute"
+      check_class_collision suffix: "Template"
+
+      class_option :inline, type: :boolean, default: false
+      class_option :parent, type: :string, desc: "The parent class for the generated template"
+      class_option :format, type: :string, default: "sql"
+      class_option :template_engine, type: :string, default: "erb"
+
+      def create_sidecar_file
+        unless options[:inline]
+          create_file File.join(template_path, class_path, "#{file_name}_template.#{options[:format]}.#{options[:template_engine]}")
+        end
+      end
+
+      def create_template_file
+        template "template.rb.erb", File.join(template_path, class_path, "#{file_name}_template.rb")
+      end
+
+      private
+
+      def template_engine
+        options[:template_engine]
+      end
+
+      def parent_class
+        return options[:parent] if options[:parent]
+        default_parent_class
+      end
+
+      def initialize_signature
+        return if attributes.blank?
+
+        attributes.map { |attr| "#{attr.name}:" }.join(", ")
+      end
+
+      def initialize_body
+        attributes.map { |attr| "@#{attr.name} = #{attr.name}" }.join("\n    ")
+      end
+
+      def initialize_call_method_for_inline?
+        options["inline"]
+      end
+
+      def default_parent_class
+        defined?(ApplicationTemplate) ? ApplicationTemplate : SuperTemplate::Base
+      end
+    end
+  end
+end

data/lib/generators/super_template/template/templates/template.rb.erb

@@ -0,0 +1,13 @@
+require "super_template/base"
+
+class <%= class_name %>Template < <%= parent_class %>
+  <%- if initialize_signature -%>
+  def initialize(<%= initialize_signature %>)
+    <%= initialize_body %>
+  end
+  <%- end -%>
+  <%- if initialize_call_method_for_inline? -%>
+  template <%= template_engine.to_sym.inspect -%>, <<-<%= template_engine.to_s.upcase %>
+  <%= template_engine.to_s.upcase %>
+  <%- end -%>
+end

data/lib/super_template/base.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require 'ostruct'
+require_relative 'compiler'
+
+module SuperTemplate
+  class Base
+    def call
+      self.class.compile unless self.class.compiled?
+      render_template
+    end
+
+    module ClassMethods
+
+      # Strips trailing whitespace from templates before compiling them.
+      #
+      # ```ruby
+      # class MyTemplate < SuperTemplate::Base
+      #   strip_trailing_whitespace
+      # end
+      # ```
+      #
+      # @param value [Boolean] Whether to strip newlines.
+      def strip_trailing_whitespace(value = true)
+        @__st_strip_trailing_whitespace = value
+      end
+
+      # Whether trailing whitespace will be stripped before compilation.
+      #
+      # @return [Boolean]
+      def strip_trailing_whitespace?
+        @__st_strip_trailing_whitespace
+      end
+
+      def source_location
+        @source_location ||= Object.const_source_location(self.name)[0]
+      end
+
+      def compiled?
+        @__st_compiled ||= false
+      end
+
+      def compile(raise_errors: false, force: false)
+        @__st_compiled ||= compiler.compile(raise_errors: raise_errors, force: force)
+      end
+
+      def compiler
+        @__st_compiler ||= SuperTemplate::Compiler.new(self)
+      end
+
+      # @param extension [Symbol] extension
+      # @param source [String] template source
+      def template(extension, source)
+        caller = caller_locations(1..1)[0]
+        @__st_inline_template = OpenStruct.new(
+          source: source,
+          type: extension,
+          path: caller.absolute_path || caller.path,
+          lineno: caller.lineno
+        )
+      end
+
+      def inline_template
+        @__st_inline_template
+      end
+
+      # Find sidecar files for the given extensions.
+      #
+      # The provided array of extensions is expected to contain
+      # strings starting without the dot, example: `["erb", "haml"]`.
+      #
+      # For example, one might collect sidecar CSS files that need to be compiled.
+      # @param extensions [Array<String>] Extensions of which to return matching sidecar files.
+      def sidecar_files(extensions)
+        return [] unless source_location
+
+        extensions = extensions.join(",")
+
+        # view files in a directory named like the component
+        directory = File.dirname(source_location)
+        filename = File.basename(source_location, ".rb")
+        component_name = ActiveSupport::Inflector.underscore(ActiveSupport::Inflector.demodulize(name))
+
+        # Add support for nested components defined in the same file.
+        #
+        # for example
+        #
+        # class MyTemplate < SuperTemplate::Base
+        #   class MyTemplate < SuperTemplate::Base
+        #   end
+        # end
+        #
+        # Without this, `MyOtherComponent` will not look for `my_component/my_other_component.html.erb`
+        nested_component_files =
+          if name.include?("::") && component_name != filename
+            Dir["#{directory}/#{filename}/#{component_name}.*{#{extensions}}"]
+          else
+            []
+          end
+
+        # view files in the same directory as the component
+        sidecar_files = Dir["#{directory}/#{component_name}.*{#{extensions}}"]
+
+        sidecar_directory_files = Dir["#{directory}/#{component_name}/#{filename}.*{#{extensions}}"]
+
+        (sidecar_files - [source_location] + sidecar_directory_files + nested_component_files).uniq
+      end
+    end
+
+    extend ClassMethods
+
+    def self.inherited(child)
+      child.extend ClassMethods
+      super
+    end
+
+    private
+    def get_binding
+      binding
+    end
+  end
+end

data/lib/super_template/compiler.rb

@@ -0,0 +1,54 @@
+require "erb"
+require "concurrent-ruby"
+require_relative "errors"
+
+module SuperTemplate
+  class Compiler
+    def initialize(template_class)
+      @template_class = template_class
+      @redefinition_lock = Mutex.new
+    end
+
+    def compile(raise_errors: false, force: false)
+      return if template_class.compiled? && !force
+      return if template_class == SuperTemplate::Base
+      template_class.superclass.compile(raise_errors: raise_errors)
+
+      redefinition_lock.synchronize do
+        templates = []
+        templates = find_sidecar_templates
+        templates << template_class.inline_template if template_class.inline_template
+        raise TemplateError, "There are #{templates.size} templates defined for #{self}" if templates.size >= 2
+        unless templates.empty?
+          compile_template(templates[0])
+        end
+      end
+      return true
+    end
+
+    protected
+
+    def find_sidecar_templates
+      template_class.sidecar_files([:erb]).map do |path|
+        pieces = File.basename(path).split(".")
+        OpenStruct.new(
+          source: File.read(path),
+          type: pieces.last,
+          path: path,
+          lineno: 0
+        )
+      end
+    end
+
+    def compile_template(template)
+      source = template.source
+      source = source.rstrip! if template_class.strip_trailing_whitespace?
+      erb = ERB.new(source)
+      erb.filename = template.path
+      erb.lineno = template.lineno
+      erb.def_method(template_class, 'render_template()')
+    end
+
+    attr_reader :template_class, :redefinition_lock
+  end
+end

data/lib/super_template/errors.rb

@@ -0,0 +1,4 @@
+module SuperTemplate
+  class TemplateError < StandardError
+  end
+end

data/lib/super_template/railtie.rb

@@ -0,0 +1,8 @@
+require_relative 'base'
+
+module SuperTemplate
+  if defined? ::Rails
+    class Railtie < ::Rails::Railtie
+    end
+  end
+end

data/lib/super_template/version.rb

@@ -0,0 +1,3 @@
+module SuperTemplate
+  VERSION = "0.1.0"
+end

data/lib/super_template.rb

@@ -0,0 +1,8 @@
+require "active_support"
+require "super_template/version"
+require "super_template/railtie"
+require "super_template/base"
+
+module SuperTemplate
+  # Your code goes here...
+end

data/lib/tasks/super_template_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :super_template do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: super_template
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chongchen Chen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+description: SQL Template for Ruby
+email:
+- chenkovsky@qq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/super_template/abstract_generator.rb
+- lib/generators/super_template/template/template_generator.rb
+- lib/generators/super_template/template/templates/template.rb.erb
+- lib/super_template.rb
+- lib/super_template/base.rb
+- lib/super_template/compiler.rb
+- lib/super_template/errors.rb
+- lib/super_template/railtie.rb
+- lib/super_template/version.rb
+- lib/tasks/super_template_tasks.rake
+homepage: https://github.com/chenkovsky/super_template
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/chenkovsky/super_template
+  source_code_uri: https://github.com/chenkovsky/super_template
+  changelog_uri: https://github.com/chenkovsky/super_template/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: SQL Template for Ruby
+test_files: []