sith 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a1f92e5a162b84d586147fa800b6c8ef2b76c1d5
+  data.tar.gz: faa395bc3debbeb5caf891a6fdf6150fd704682d
+SHA512:
+  metadata.gz: 03f0c6392a6bd10d7a034f664e112f07597314b9c5b99958632cdcb97f4f82027d40efba8028bc0b7e675df620834a1d63683bfb9dc317e05cbdc05af1f4b4b5
+  data.tar.gz: b59a612d590c693abdb8ea0b7f1f514e19fd05e4f2835aa373d2ade8458e4e57f3ed156cde6c4e46de99cdddbe5621994b3b45d4407c86bce57a2472ef4d1cc9

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'parser'
+gem 'unparser'
+
+group :development, :test do
+  gem 'rspec'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Alexander Ivanov
+
+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,71 @@
+# sith
+
+sith is a macro preprocessor for Ruby
+
+[![Build Status](https://travis-ci.org/alehander42/sith.svg)](https://travis-ci.org/alehander42/sith)
+
+Still a prototype.
+
+Example:
+
+a macro definitions file:
+
+```ruby
+macro_mapper attr_reader(label, delimiter: "\n")
+  def ~{label}
+  	@~{label}
+  end
+end
+
+macro_mapper attr_writer(label, delimiter: "\n")
+  def ~{label}=(value)
+  	@~{label} = value
+  end
+end
+
+macro attr_accessor(*labels)
+  attr_reader ~{labels}
+  attr_writer ~{labels}
+end
+```
+
+a ruby file
+```
+class A
+  attr_accessor a
+end
+```
+
+```zsh
+sith ruby_file.rb macro_definitions.rb > output.rb`
+```
+
+output.rb
+
+```ruby
+class A
+  def a
+    @a
+  end
+  def a=(value)
+    @a = value
+  end
+end
+```
+# install
+
+`gem install sith`
+
+# thanks
+
+built on top of [parser](https://github.com/whitequark/parser) and [unparser](https://github.com/mbj/unparser) gems.
+
+# similar to
+
+[rubymacros](https://github.com/coatl/rubymacros/)
+
+however, the macros in `sith` are defined using a ruby-like template notation, not a lisp-like ast notation.
+
+# built by
+
+[Alexander Ivanov](http://alehander42.me)

data/Rakefile

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/bin/sith

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'sith'
+
+ruby_file, filename = ARGV.first, ARGV[1]
+
+ruby_source = File.read(ruby_file)
+macro_source = File.read(filename)
+
+expander = Sith::MacroExpander.new(Sith::load_macros(macro_source))
+puts expander.expand_to_source(ruby_source)
+
+

data/examples/attributes.rb

@@ -0,0 +1,17 @@
+macro_mapper attr_reader(label, delimiter: "\n")
+  def ~{label}
+  	@~{label}
+  end
+end
+
+macro_mapper attr_writer(label, delimiter: "\n")
+  def ~{label}=(value)
+  	@~{label} = value
+  end
+end
+
+macro attr_accessor(*labels)
+  attr_reader ~{labels}
+  attr_writer ~{labels}
+end
+

data/examples/example0.rb

@@ -0,0 +1,5 @@
+class A
+  attr_reader a
+  attr_writer b
+  attr_accessor c
+end

data/examples/example1.rb

@@ -0,0 +1,3 @@
+def a
+  simple 2, 4
+end

data/examples/simple.rb

@@ -0,0 +1,3 @@
+macro simple(a, b)
+  ~{a} + ~{b}
+end

data/lib/sith.rb

@@ -0,0 +1,3 @@
+require_relative 'sith/macro'
+require_relative 'sith/loader'
+require_relative 'sith/macro_expander'

data/lib/sith/loader.rb

@@ -0,0 +1,39 @@
+module Sith
+  def self.load_macros(macro_source)
+    lines = macro_source.split("\n")
+    macros = {}
+    i = 0
+    while i < lines.length
+      line = lines[i]
+      if line.lstrip.start_with? 'macro_mapper'
+        offset = line.length - line.lstrip.length
+        a = line.index('(')
+        label = line[offset + 12...a].strip.to_sym
+        args = line[a + 1..-1].rstrip[0...-1].split(/[, \"]/)
+        arg = args[0].to_sym
+        delimiter =  args.length >= 2 ? args[-1] : "\n"
+        end_index = lines[i..-1].find_index { |l| (l[offset..-1] || '').start_with? 'end' }
+        body = lines[i + 1...i + end_index].join("\n")
+        i = i + end_index + 1
+        macros[label] = MacroMapper.new(arg, delimiter, body)
+      elsif line.lstrip.start_with? 'macro'
+        offset = line.length - line.lstrip.length
+        a = line.index('(')
+        label = line[offset + 5...a].strip.to_sym
+        args = line[a + 1..-1].rstrip[0...-1].split(',').map(&:strip)
+        if args.length == 1 && args[0][0] == '*'
+          stararg, args = true, [args[0][1..-1].to_sym]
+        else
+          stararg, args = false, args.map(&:to_sym)
+        end
+        end_index = lines[i..-1].find_index { |l| (l[offset..-1] || '').start_with? 'end' }
+        body = lines[i + 1...i + end_index].join("\n")
+        i = i + end_index + 1
+        macros[label] = Macro.new(args, stararg, body)
+      else
+        i += 1
+      end
+    end
+    macros
+  end
+end

data/lib/sith/macro.rb

@@ -0,0 +1,66 @@
+require 'parser/current'
+
+module Sith
+  class BaseMacro
+    def represent(node)
+      return node.to_s unless node.is_a?(Parser::AST::Node) || node.is_a?(Array)
+
+      if node.is_a?(Array)
+        "#{node.map(&method(:represent)).join(', ')}"
+      elsif node.type == :int
+        node.children[0].to_s
+      elsif node.type == :string
+        node.children[0]
+      elsif :send
+        node.children[1].to_s
+      else
+        '?'
+      end
+    end
+
+    def expand_macro(nodes)
+      a = expand_to_source(nodes)
+
+      Parser::CurrentRuby.parse a
+    end
+  end
+
+  class Macro < BaseMacro
+    attr_reader :labels, :stararg, :template
+
+    def initialize(labels, stararg=false, template='')
+      @stararg = stararg
+      @labels = labels
+      @template = template
+    end
+
+    def expand_to_source(nodes)
+      if @stararg
+        substitutions = {@labels[0] => represent(nodes)}
+      else
+        representations = nodes.map { |node| represent node }
+        substitutions = Hash[@labels.zip(representations)]
+      end
+      @template.gsub(/~\{(\w+)\}/) do |label|
+
+
+        substitutions[Regexp.last_match(1).to_sym]
+      end
+    end
+  end
+
+  class MacroMapper < BaseMacro
+    attr_reader :label, :delimiter, :body
+
+    def initialize(label, delimiter="\n", body='')
+      @label = label
+      @delimiter = delimiter
+      @body = body
+    end
+
+    def expand_to_source(nodes)
+      macros = nodes.map { |n| Macro.new([label], false, @body)}
+      macros.map { |m| m.expand_to_source(nodes) }.join(delimiter)
+    end
+  end
+end

data/lib/sith/macro_expander.rb

@@ -0,0 +1,30 @@
+require 'parser/current'
+require 'unparser'
+
+module Sith
+  class MacroExpander
+    def initialize(macros)
+      @macros = macros
+    end
+
+    def expand(source)
+      ast = Parser::CurrentRuby.parse(source)
+      expand_node ast
+    end
+
+    def expand_to_source(source)
+      Unparser.unparse(expand(source))
+    end
+
+    def expand_node(node)
+      return node unless node.is_a?(Parser::AST::Node)
+
+      if node.type == :send && @macros.key?(node.children[1])
+        node = @macros[node.children[1]].expand_macro(node.children[2..-1])
+      end
+      children = node.children.map(&method(:expand_node))
+      Parser::AST::Node.new node.type, children
+    end
+  end
+end
+

data/sith.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'sith'
+  s.version     = '0.1.0'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Alexander Ivanov"]
+  s.email       = ["alehander42@gmail.com"]
+  s.homepage = 'https://github.com/alehander42/sith'
+  s.summary     = %q{A macro preprocessor for Ruby}
+  s.description = %q{A macro preprocessor for Ruby with ruby-like template notation}
+
+  s.add_development_dependency 'rspec', '~> 0'
+  s.add_runtime_dependency('parser', '~> 2.2')
+  s.add_runtime_dependency('unparser', '~> 0.2')
+
+  s.license       = 'MIT'
+  s.executables   = ["sith"]
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/sith_spec.rb

@@ -0,0 +1,75 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'parser'
+require 'sith'
+
+module Sith
+  describe Sith do
+    it 'can load macros from your macros definitions' do
+      source = <<-RUBY
+        macro simple(a, b)
+          ~{a} + ~{b}
+        end
+      RUBY
+
+      macros = Sith::load_macros(source)
+      macro = macros[:simple]
+      expect(macro).to be_a Macro
+      expect(macro.labels[0]).to be_a Symbol
+      expect(macro.labels[0]).to eq :a
+      expect(macro.template.strip).to eq '~{a} + ~{b}'
+    end
+
+    it 'can load macro mappers from your macros definitions' do
+      source = <<-RUBY
+        macro_mapper attr_reader(attr, delimiter: ";")
+          def ~{attr}
+            @~{attr}
+          end
+        end
+        RUBY
+
+      macros = Sith::load_macros(source)
+      macro = macros[:attr_reader]
+      expect(macro).to be_a MacroMapper
+      expect(macro.label).to eq :attr
+      expect(macro.body.strip).to eq "def ~{attr}\n            @~{attr}\n          end"
+      expect(macro.delimiter).to eq ";"
+    end
+
+    describe 'MacroExpander' do
+      it 'can expand macros' do
+        macros = {simple: Macro.new([:a, :b],
+                                    false,
+                                    '~{a} + ~{b}')}
+        source = <<-RUBY
+          a = x + 4
+          simple(2, 4)
+        RUBY
+        expanded = MacroExpander.new(macros).expand(source)
+        expect(expanded.children[1].type).to eq :send
+        expect(expanded.children[1].children[2].type).to eq :int
+      end
+
+      it 'can expand macro mappers' do
+        macros = {attr_reader: MacroMapper.new(:attr,
+                                         "\n",
+                                         "def ~{attr};@~{attr};end")}
+        source = <<-RUBY
+          class A
+            attr_reader a
+          end
+        RUBY
+        expanded = MacroExpander.new(macros).expand(source)
+        expect(expanded.children[2].type).to eq :def
+        expect(expanded.children[2].children[2].type).to eq :ivar
+        expect(expanded.children[2].children[2].children[0]).to eq :@a
+      end
+    end
+  end
+end
+
+
+
+

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: sith
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexander Ivanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: unparser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: A macro preprocessor for Ruby with ruby-like template notation
+email:
+- alehander42@gmail.com
+executables:
+- sith
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/sith
+- examples/attributes.rb
+- examples/example0.rb
+- examples/example1.rb
+- examples/simple.rb
+- lib/sith.rb
+- lib/sith/loader.rb
+- lib/sith/macro.rb
+- lib/sith/macro_expander.rb
+- sith.gemspec
+- spec/sith_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/alehander42/sith
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: A macro preprocessor for Ruby
+test_files:
+- spec/sith_spec.rb
+- spec/spec_helper.rb