filtri 0.0.1

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+Gemfile.lock
+.idea

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,15 @@
+Copyright (c) 2013 Karl L <karl@ninjacontrol.com>
+
+MIT License
+
+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,63 @@
+Filtri
+======
+
+Filtri is a tiny DSL for text substitution.
+
+## Installation
+
+    $ gem install filtri
+
+## Usage
+
+Define a set of substitution rules using `rule` and apply to an input string:
+
+    in_str = "foobazbarfoo"
+    expected = "barbugbarbar"
+
+    f = filtri do
+      rule /fo+/ => "bar"
+      rule "baz" => "bug"
+    end
+
+    f.apply("foobazbarfoo")
+    => "barbugbarbar"
+
+Rules can also be read from a file:
+
+File `foo.rules`:
+
+     # this is a comment
+     rule /fo+bar/ => "bazbag"
+     rule /(a)+/ => '!!\1!!'
+     rule /(b)+/ => '**\1**'
+
+Load with `Filtri::load`:
+
+    Filtri.load("foo.rules").apply("foobarfoobar")
+    => "**b**!!a!!z**b**!!a!!g**b**!!a!!z**b**!!a!!g"
+
+## Version information
+
+* 0.0.1 - Initial version
+
+## License
+
+Copyright (c) 2013 Karl L <karl@ninjacontrol.com>
+
+MIT License
+
+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.
+
+## Author
+
+Karl L, <karl@ninjacontrol.com>

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:test)
+

data/filtri.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'filtri/version'
+
+Gem::Specification.new do |spec|
+  
+  spec.name          = "filtri"
+  spec.version       = Filtri::VERSION
+  spec.authors       = ["karl l"]
+  spec.email         = ["karl@ninjacontrol.com"]
+  spec.date          = '2013-04-01'
+  spec.summary       = "A tiny DSL for filtering strings"
+  spec.description   = "Filtri is a little DSL that simplifies the work of applying multiple substitution rules to a string."
+  spec.homepage      = "https://github.com/karlll/filtri/"
+  spec.license       = "MIT"
+  
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_runtime_dependency "docile"
+  spec.add_runtime_dependency "str2hash"
+  spec.add_runtime_dependency "to_regexp"
+ 
+  end
+  

data/lib/filtri.rb

@@ -0,0 +1,183 @@
+require 'docile'
+require 'pp'
+require 'to_regexp'
+require 'str2hash'
+
+# Filtri DSL
+# @author karl l <karl@ninjacontrol.com>
+class Filtri
+
+  # The rules
+  attr_reader :rules
+  # The meta rules
+  attr_reader :meta_rules
+
+  # @private
+  RULES = [:rule, :meta]
+
+
+
+  def initialize
+    @rules      = []
+    @meta_rules = []
+    @passes     = 1
+  end
+
+  # Add a filtering rule
+  # @param [Hash{Regexp => String},Hash{String => String}] rule_hash
+  def rule(rule_hash)
+    add_rule(@rules, rule_hash)
+  end
+
+  # Add a meta rule
+  # @param [Hash{Regexp=>String}] rule_hash
+  def meta(rule_hash)
+    add_rule(@meta_rules, rule_hash)
+  end
+
+  # Add a rule to the current rule-set
+  # @param [Array<Hash{Regexp => String},Hash{String => String}>] rule_set
+  # @param [Hash{Regexp => String},Hash{String => String}] rule_hash
+  # @private
+  def add_rule(rule_set, rule_hash)
+
+    rule_hash.each_key do |k|
+      rule_set << { from: k, to: rule_hash[k] }
+    end
+
+  end
+
+  # @param [Regexp, String] val
+  # @param [Hash{Regexp => String},Hash{String => String}] rule
+  # @private
+  def do_rewrite(val, rule)
+    case val
+      when Regexp
+        val_str = PP.singleline_pp(val, "")
+        val_str.gsub!(rule[:from], rule[:to])
+        val_str.to_regexp
+      when String
+        val.gsub(rule[:from], rule[:to])
+      else
+        val
+    end
+
+  end
+
+  # Rewrite a hash with a set of rules
+  # @param [Hash{Regexp => String},Hash{String => String}] in_hash
+  # @param [Hash{Regexp => String},Hash{String => String}] rules
+  # @private
+  def rewrite(in_hash, rules)
+    out_hash = []
+    in_hash.each do |v|
+      f = v[:from]
+      t = v[:to]
+
+      rules.each do |r|
+        f = do_rewrite(f, r)
+        t = do_rewrite(t, r)
+      end
+      out_hash << { from: f, to: t }
+    end
+    out_hash
+  end
+
+
+  # Apply filtering rules to the provided string
+  # @param [String] in_str
+  # @return [String] the resulting string
+  def apply(in_str)
+
+    @passes.times do
+
+      unless @meta_rules.empty?
+        @rules = rewrite(@rules, @meta_rules)
+      end
+
+      @rules.each do |rule|
+        in_str = in_str.gsub(rule[:from], rule[:to])
+      end
+
+    end
+    in_str
+  end
+
+  # Factory, init with rule-set from a string
+  #
+  # The input string is expected to contain rules and comments, one per line,
+  # separated by a line break.
+  # The expected format of a line is "{operation} <space> {argument} <eol>".
+  # Empty lines and lines starting with a '#' are ignored. Whitespace at the beginning of a line
+  # is trimmed.
+  #
+  # @param [String] rule_str
+  # @return [Filtri] A new Filtri object with the rules parsed from the provided string(s).
+  # @raise [FiltriInitError] if an error occurs when initialising the rules from the provided strings
+  def self.from_str(rule_str)
+
+    inst = Filtri.new
+
+    rule_str.strip.lines do |l|
+
+      op_str = l.strip.partition " "
+      if op_str[0].length > 0
+        op     = op_str[0]
+        op_arg = op_str[2]
+
+        if Filtri::RULES.include? op.to_sym
+          # parse arg string
+          begin
+            arg_hash = op_arg.to_h
+          rescue Parslet::ParseFailed => err
+            raise FiltriInitError, "Invalid rule format: '#{op_arg}' (#{err.message})"
+          end
+          # add rule
+          inst.send(op.to_sym,arg_hash)
+        else
+          raise FiltriInitError, "Unknown rule: #{op}" unless op == "#"
+        end
+
+      end
+    end
+
+    inst
+
+  end
+
+  # Load rules from a file
+  # @param [String] file_name
+  # @return [Filtri] A new Filtri object with the rules contained in the file
+  # @raise [IOError,SystemCallError] If an error occurs when opening the file
+  # @raise [FiltriInitError] If an error occurs when parsing the rules in the file
+  def self.load(file_name)
+
+    data = IO.read(file_name)
+    Filtri.from_str(data)
+
+  end
+
+
+end
+
+class FiltriInitError < StandardError
+  def initialize(msg)
+    super(msg)
+    @msg = msg
+  end
+end
+
+
+# Create a Filtri object containing a set of rules
+#
+# @example
+#
+#   f = filtri do
+#       rule "foo" => "bar"
+#       rule "baz" => "bug"
+#   end
+#
+# @return [Filtri] A new Filtri object containing the provided rules
+def filtri(&block)
+  Docile.dsl_eval(Filtri.new, &block)
+end

data/lib/filtri/version.rb

@@ -0,0 +1,6 @@
+class Filtri
+
+  # Filtri version (semantic versioning)
+  VERSION = "0.0.1"
+
+end

data/spec/filtri_spec.rb

@@ -0,0 +1,223 @@
+require "rspec"
+require "filtri"
+
+describe Filtri do
+
+  it "applies a rule to translate a string" do
+
+    in_str = "foo\nbaz\nbar\nfoo"
+    expected = "bar\nbug\nbar\nbar"
+
+    f = filtri do
+      rule "foo" => "bar"
+      rule "baz" => "bug"
+    end
+
+    result = f.apply(in_str)
+    expect(result).to eq(expected)
+
+
+  end
+
+  it "applies a simple regexp rule to translate a string" do
+
+    in_str = "foo\nbaz\nbar\nfoo"
+    expected = "bar\nbug\nbar\nbar"
+
+    f = filtri do
+      rule /fo+/ => "bar"
+      rule "baz" => "bug"
+    end
+
+    result = f.apply(in_str)
+    expect(result).to eq(expected)
+
+
+  end
+
+  it "applies a regexp and include matches in the result" do
+
+    in_str = "This is a test XXXXX"
+    expected = "This is a passing test ! (XXXXX)"
+
+    f = filtri do
+      rule /(test)/ => 'passing \1'
+      rule /(X+)/ => '! (\1)'
+    end
+
+    result = f.apply(in_str)
+    expect(result).to eq(expected)
+
+
+  end
+
+
+  it "re-writes rules with meta-rules" do
+
+    in_str = "foo\nbaz\nbar\nfoo"
+    expected = "bar\nbug\nbar\nbar"
+
+
+    f = filtri do
+      meta /META/ => 'fo+'
+      rule /META/ => "bar"
+      rule "baz" => "bug"
+    end
+
+    result = f.apply(in_str)
+    expect(result).to eq(expected)
+
+
+  end
+
+  it "re-writes regexps and plain strings with meta-rules" do
+
+    in_str = "foobarfoobar"
+    expected = "bazbagbazbag"
+
+
+    f = filtri do
+      meta "FB" => "foobar"
+      rule /FB/ => "bazbag"
+    end
+
+    result = f.apply(in_str)
+    expect(result).to eq(expected)
+
+
+  end
+
+  it "applies meta-rules on both parts of the rule" do
+
+    in_str = "foobarfoobar"
+    expected = "bazbagbazbag"
+
+
+    f = filtri do
+      meta "FB" => "bazbag"
+      rule /foobar/ => "FB"
+    end
+
+    result = f.apply(in_str)
+    expect(result).to eq(expected)
+
+  end
+
+
+  it "parses rules from strings" do
+
+
+
+    in_str = "foobarfoobar"
+    expected = "bazbagbazbag"
+
+    strings = <<EOF
+
+    rule /fo+bar/ => "bazbag"
+
+EOF
+
+
+    result = Filtri.from_str(strings).apply(in_str)
+
+    expect(result).to eq(expected)
+
+  end
+
+  it "parses rules with comments and empty lines" do
+
+    in_str = "foobarfoobar"
+    expected = "**b**!!a!!z**b**!!a!!g**b**!!a!!z**b**!!a!!g"
+
+    strings = %q(
+
+    # this is a comment
+    rule /fo+bar/ => "bazbag"
+    rule /(a)+/ => '!!\1!!'
+    rule /(b)+/ => '**\1**'
+
+    # empty line above
+    rule "text" => "some other text"
+
+
+
+)
+
+
+    f = Filtri.from_str(strings)
+    result = f.apply(in_str)
+
+    expect(result).to eq(expected)
+
+  end
+
+  it "raises an exception when parsing an unknown rule" do
+
+
+    strings = %q(
+
+    # Below are valid rules
+
+    meta /XXX/ => "YYYYY"
+    rule /FOO/ => "BAR"
+
+    # Below is an unknown rule name
+    stupid_rule /BAG/ => "BAR"
+
+)
+    expect { Filtri.from_str(strings) }.to raise_error(FiltriInitError)
+
+  end
+
+  it "raises an exception when parsing an invalid rule format" do
+
+
+    strings = %q(
+
+    # Below are valid rules
+
+    meta /XXX/ => "YYYYY"
+    rule /FOO/ => "BAR"
+
+    # Below is an a rule w. invalid format
+    rule NOT_VALID
+
+)
+    expect { Filtri.from_str(strings) }.to raise_error(FiltriInitError)
+
+  end
+
+
+  it "loads rules from external files" do
+
+    in_str = "foobarfoobar"
+    expected = "bazbagbazbag"
+
+
+    content = %q(
+
+  # this is a comment
+  rule /fo+bar/ => "bazbag"
+
+)
+
+    IO.stub(:read).with("test.filtri").and_return content
+
+    filename = "test.filtri"
+
+    result = Filtri.load(filename).apply(in_str)
+
+    expect(result).to eq(expected)
+
+
+  end
+
+  it "raises an exception when file is missing" do
+
+
+    expect { Filtri.load("stupid_invalid_file") }.to raise_error(SystemCallError)
+
+  end
+
+
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: filtri
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- karl l
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: docile
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: str2hash
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: to_regexp
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Filtri is a little DSL that simplifies the work of applying multiple
+  substitution rules to a string.
+email:
+- karl@ninjacontrol.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- filtri.gemspec
+- lib/filtri.rb
+- lib/filtri/version.rb
+- spec/filtri_spec.rb
+homepage: https://github.com/karlll/filtri/
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1607576313604211744
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1607576313604211744
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A tiny DSL for filtering strings
+test_files:
+- spec/filtri_spec.rb