twofold 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1c4cd42bb2d0a4784a901001526f0e8b1be277a246216ddfc01a90b5b90a4f5e
+  data.tar.gz: 0c46e895372b3b787a395a93c3d450bd76b9f9a1ba60ec662a0ad4f4748a0c75
+SHA512:
+  metadata.gz: 003cfddf5433e6ecc2524222c37f02aab54bbef54a49233ee5737c9a73ac033401828b3392f21fe860d874503708525c0015d11bd86ee6f36ae8843ac1557a5b
+  data.tar.gz: 67f645616f34aa5573812ef1fe782ea7c5f2cccef15fb866f7abef286be1ec20fc5bb753e74bbb28ae7ea022dbdc1fd0bfad948e3de254dbf0bf8be83cc23e0e

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,8 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4
+
+script: bundle exec rake spec

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at andreas.reischuck@hicknhack-software.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Andreas Reischuck
+
+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,120 @@
+# Twofold Ruby
+
+**Generate correctly indented source code with the power of Ruby**
+
+Welcome to the Ruby implementation of Twofold.
+
+## Motivation
+
+Most template engines like Slim or Haml are focused towards HTML.
+ERB allows you to generate any text, but control structures are cumbersome.
+
+We want to be able to read the target language and also the control language.
+
+With the power of Ruby it's all very easy.
+
+## Features
+
+* indentation stacking
+* control every generated line and every whitespace
+* some unit tests
+
+## Syntax
+
+Unlike most template languages every line is Ruby unless it starts with on of:
+
+* `|` - followed by output text, breaks the output line
+* `\\` - followed by output text without breaking the output line
+* `=` - followed by ruby code
+
+Output text can contain `#{interpolated}` ruby code.
+
+Whitespaces BEFORE these symbols are ignored.
+But whitespaces AFTER the symbols are used as output indentations.
+These indentations stack.
+
+Let's look at an example:
+
+## Example
+
+```twofold
+def self.greet_method(name, greet)
+                    |def greet_#{name}(name)
+                    |  puts("#{greet} \#{name}")
+                    |end
+  return # be careful what you return.
+end
+                    |class Greeters
+methods.each do |m|
+                    =  greet_method(m[:name], m[:greet])
+end
+                    |end
+```
+
+If we provide the following locals:
+```ruby
+locals = {
+  methods: [
+    { name: "hello", greet: "Hello World of " },
+    { name: "tag", greet: "Guten Tag " },
+  ]
+}
+```
+
+Twofold will produce:
+```ruby
+class Greeters
+  def greet_world(name)
+    puts("Hello World of #{name}")
+  end
+  def greet_tag(name)
+    puts("Guten Tag #{name}")
+  end
+end
+```
+
+Notice how all the methods and their content are indented into the class, even though there is no indentation in the template?
+This is because we call `greet_method` with the two space indentation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'twofold-temple'
+```
+
+## Usage
+
+You simply create a Tilt template (`Twofold::Template`)
+
+```ruby
+require 'twofold'
+
+Twofold::Template.new('template.twofold').render(scope)
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies.
+Then, run `rake spec` to run the tests.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, 
+which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hicknhack-software/twofold.temple. 
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to 
+the [code of conduct](https://github.com/hicknhack-software/twofold-temple/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+Twofold is released under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the twofold project's codebases, issue trackers, chat rooms and mailing lists 
+is expected to follow the [code of conduct](https://github.com/[USERNAME]/Twofold-Temple/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "twofold"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/lib/twofold.rb

@@ -0,0 +1,11 @@
+require 'temple'
+require 'twofold/version'
+
+module Twofold
+  autoload :Engine, 'twofold/engine'
+  autoload :Parser, 'twofold/parser'
+  autoload :Template, 'twofold/template'
+  autoload :Filter, 'twofold/filter'
+  autoload :Interpolation, 'twofold/interpolation'
+  autoload :Indentation, 'twofold/indentation'
+end

data/lib/twofold/engine.rb

@@ -0,0 +1,14 @@
+module Twofold
+  class Engine < Temple::Engine
+    use Twofold::Parser
+
+    use Twofold::Interpolation
+    use Twofold::Indentation
+
+    filter :ControlFlow
+    filter :MultiFlattener
+    filter :StaticMerger
+
+    generator :ArrayBuffer, buffer: "@_buf" # we use buffer attribute so custom methods can use it too
+  end
+end

data/lib/twofold/filter.rb

@@ -0,0 +1,17 @@
+module Twofold
+
+  # Base class for Filters used in Twofold
+  #
+  # Add all recursive S-Expressions!
+  #
+  # @api private
+  class Filter < Temple::Filter
+
+    # Pass-through handler
+    def on_twofold_indented(indent, inner)
+      [:twofold, :indented, indent, compile(inner)]
+    end
+
+  end
+
+end

data/lib/twofold/indentation.rb

@@ -0,0 +1,71 @@
+module Twofold
+  class Indentation < Filter
+    define_options indent: "@_indent", # stack of indentation strings
+                   indented: "@_indented" # is current line already indented?
+
+    def initialize(opts = {})
+      super
+      @indent = options[:indent]
+      @indented = options[:indented]
+    end
+
+    def on_twofold_indented(indent, inner)
+      block = [:multi]
+      block << [:code, "(#{@indent} ||= []) << '#{indent}'"]
+      block << compile(inner)
+      block << [:code, "#{@indent}.pop"]
+      block
+    end
+
+    def on_twofold_newline
+      [:multi,
+       [:code, "#{@indented} = false"],
+       [:static, "\n"]
+      ]
+    end
+
+    def on_static(string)
+      if string.empty?
+        [:static, string]
+      else
+        [:multi,
+         ensure_indent,
+         [:static, string]
+        ]
+      end
+    end
+
+    def on_dynamic(ruby)
+      [:multi,
+       [:capture, 'tmp', [:dynamic, ruby]],
+       [:if,
+        'not tmp.nil? and not tmp.empty?',
+        [:block,
+         'tmp.split(/(?<=\n)/).each do |line|',
+         [:multi,
+          ensure_indent,
+          [:dynamic, "line"],
+          [:if,
+           "line[-1] == #{'"\n"'}",
+           [:code, "#{@indented} = false"]
+          ]
+         ]
+        ]
+       ]
+      ]
+    end
+
+    private
+
+    def ensure_indent
+      [:if,
+       "not #{@indented}",
+       [:multi,
+        [:code, "#{@indented} = true"],
+        [:dynamic, "(#{@indent} ||= [])*''"]
+       ]
+      ]
+    end
+
+  end
+end

data/lib/twofold/interpolation.rb

@@ -0,0 +1,29 @@
+module Twofold
+  class Interpolation < Filter
+    # Works like Temple::Filters::StringSplitter but does not require ripper
+    def on_twofold_interpolate(input)
+      # Interpolate ruby code in text (#{variable}).
+      # Split the text into multiple dynamic and static parts.
+      block = [:multi]
+      string = input
+      begin
+        case string
+        when /\A\\#\{/
+          # Escaped interpolation
+          block << [:static, '#{']
+          string = $'
+        when /\A#\{((?>[^{}]|(\{(?>[^{}]|\g<1>)*\}))*)\}/
+          # Interpolation
+          string, code = $', $1
+          escape = code !~ /\A\{.*\}\Z/
+          block << [:dynamic, escape ? code : code[1..-2]]
+        when /\A([#\\]?[^#\\]*([#\\][^\\#\{][^#\\]*)*)/
+          # Static text
+          block << [:static, $&]
+          string = $'
+        end
+      end until string.empty?
+      block
+    end
+  end
+end

data/lib/twofold/parser.rb

@@ -0,0 +1,59 @@
+module Twofold
+  class Parser < Temple::Parser
+
+    def call(input)
+      result = [:multi]
+
+      @lines = input.split(/\r?\n/)
+      @line_no = 0
+      @stack = [result]
+
+      parse_line while next_line
+
+      result
+    end
+
+    def next_line
+      if @lines.empty?
+        @line = nil
+      else
+        @line = @lines.shift
+        @line_no += 1
+      end
+    end
+
+    def parse_line
+      line = @line.lstrip
+
+      case line[0]
+      when '\\'
+        indented line[1..] do |text|
+          @stack.last << [:twofold, :interpolate, text]
+        end
+      when '|'
+        indented line[1..] do |text|
+          @stack.last << [:twofold, :interpolate, text]
+        end
+        @stack.last << [:twofold, :newline]
+      when '='
+        indented line[1..] do |code|
+          @stack.last << [:code, code]
+        end
+      when nil
+        # empty line
+      else
+        @stack.last << [:code, line]
+      end
+      @stack.last << [:newline]
+    end
+
+    def indented(str)
+      indent = str[/\A\s*/]
+      @stack.push([:multi])
+      yield str.lstrip
+      inner = @stack.pop
+      @stack.last << [:twofold, :indented, indent, inner]
+    end
+
+  end
+end

data/lib/twofold/template.rb

@@ -0,0 +1,3 @@
+module Twofold
+  Template = Temple::Templates::Tilt(Engine)
+end

data/lib/twofold/version.rb

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

data/twofold.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/twofold/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "twofold"
+  spec.version       = Twofold::VERSION
+  spec.authors       = ["Andreas Reischuck"]
+  spec.email         = ["andreas.reischuck@hicknhack-software.com"]
+
+  spec.summary       = %q{Twofold template engine to generate any indented source code.}
+  #spec.description   = %q{Work in progress}
+  spec.homepage      = "https://github.com/hicknhack-software/twofold-ruby"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/hicknhack-software/twofold-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/hicknhack-software/twofold-ruby"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency('temple')
+  spec.add_runtime_dependency('tilt')
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: twofold
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andreas Reischuck
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: temple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- andreas.reischuck@hicknhack-software.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- lib/twofold.rb
+- lib/twofold/engine.rb
+- lib/twofold/filter.rb
+- lib/twofold/indentation.rb
+- lib/twofold/interpolation.rb
+- lib/twofold/parser.rb
+- lib/twofold/template.rb
+- lib/twofold/version.rb
+- twofold.gemspec
+homepage: https://github.com/hicknhack-software/twofold-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hicknhack-software/twofold-ruby
+  source_code_uri: https://github.com/hicknhack-software/twofold-ruby
+  changelog_uri: https://github.com/hicknhack-software/twofold-ruby
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Twofold template engine to generate any indented source code.
+test_files: []