stringfire 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in stringfire.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 conanite
+
+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,64 @@
+# Stringfire
+
+Strip the first token off a string, pass remainder of string as arg to function identified by first token
+
+Useful where you want user-supplied executable expressions embedded in your data (in a CMS for example), but for obvious reasons you're not going to let them write ruby code
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'stringfire'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stringfire
+
+## Usage
+
+    @interpreter = Stringfire::Interpreter.new
+
+    @interpreter.command("say-hello") { |arg| "hello, #{arg}" }
+
+    @interpreter.interpret "say-hello dear user" # => "hello, dear user"
+
+You can nest interpreters
+
+    @interpreter.command("if-admin") { |arg| User.admin? ? @interpreter.interpret(arg) : "" }
+
+    login_as(admin_user)
+    @interpreter.interpret "if-admin say-hello dear user" # => "hello, dear user"
+
+    logout
+    @interpreter.interpret "if-admin say-hello dear user" # => ""
+
+You can pass arbitrary additional args
+
+    @interpreter.command("say-bye") { |arg, lovely, days| "bye-bye, #{arg}, it was #{lovely} to meet you, see you in #{days} days" }
+
+    @interpreter.interpret("say-bye dear user", "wonderful", 2) # => "bye-bye, dear user, it was wonderful to meet you, see you in 2 days"
+
+Additional args may be useful in a Rails context if you need to pass an ActionController or ActionView instance to your commands :
+
+    @interpreter.command("tweets") { |arg, view| view.render_cell :tweets, :show, arg.split(/,/) }
+
+    @interpreter.interpret("tweets conanite, 10, no-RT", view) # => same as calling view.render_cell(:tweets, :show, "conanite", "10", "no-RT")
+
+You can specify a default handler for unknown commands
+
+    @interpreter.default { |text, *args| raise "Unable to interpret '#{text}': available commands are #{@interpreter.command_names.join ', '}" }
+
+    @interpreter.interpret("foobar toto james anthony krishna", 1, 2, 3) # => Error: Unable to interpret 'foobar toto james anthony krishna': available commands are say-hello, if-admin, say-bye
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/stringfire.rb

@@ -0,0 +1,43 @@
+require "stringfire/version"
+
+module Stringfire
+
+  class Interpreter
+    def split_first_word str
+      result = str.strip.split /\s/, 2
+      result << "" while result.size < 2
+      result
+    end
+
+    def initialize
+      @commands = { }
+      default { |command, *args| command }
+    end
+
+    def command name, &block
+      @commands[name] = block
+    end
+
+    def command_names
+      @commands.keys
+    end
+
+    def default *args, &block
+      if block_given?
+        @default = block
+      else
+        @default.call *args
+      end
+    end
+
+    def interpret command_text, *args
+      name, details = split_first_word command_text
+      if @commands.key? name
+        @commands[name].call details, *args
+      else
+        default command_text, *args
+      end
+    end
+  end
+
+end

data/lib/stringfire/version.rb

@@ -0,0 +1,3 @@
+module Stringfire
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require "stringfire"
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/stringfire/interpreter_spec.rb

@@ -0,0 +1,56 @@
+# -*- coding: utf-8 -*-
+
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Stringfire::Interpreter do
+
+  class User
+    attr_accessor :admin
+  end
+
+  let(:interpreter) { Stringfire::Interpreter.new }
+
+  let(:user) { User.new }
+
+  before {
+    interpreter.command("say-hello") { |arg| "hello, #{arg}" }
+    interpreter.command("if-admin") { |arg| user.admin ? interpreter.interpret(arg) : "" }
+    interpreter.command("say-bye") { |arg, lovely, days| "bye-bye, #{arg}, it was #{lovely} to meet you, see you in #{days} days" }
+    interpreter.command("tweets") { |arg, view| view.render_cell :tweets, :show, *arg.split(/\s*,\s*/) }
+    interpreter.default { |text, *args| raise "Unable to interpret '#{text}': available commands are #{interpreter.command_names.join ', '}" }
+  }
+
+  it "should say hello" do
+    interpreter.interpret("say-hello dear user").should == "hello, dear user"
+  end
+
+  it "should say hello to admin" do
+    user.admin = true
+    interpreter.interpret("if-admin say-hello dear user").should == "hello, dear user"
+  end
+
+  it "should say nothing to non-admin" do
+    user.admin = false
+    interpreter.interpret("if-admin say-hello dear user").should == ""
+  end
+
+  it "should say goodbye with axtra args" do
+    interpreter.interpret("say-bye dear user", "wonderful", 2).should == "bye-bye, dear user, it was wonderful to meet you, see you in 2 days"
+  end
+
+  it "should be useful in a Rails context" do
+    view = mock("view")
+    view.should_receive(:render_cell).with(:tweets, :show, "conanite", "10", "no-RT").and_return "conanite's fascinating tweets"
+
+    interpreter.interpret("tweets conanite, 10, no-RT", view).should == "conanite's fascinating tweets"
+  end
+
+  it "should be unable to interpret foobar" do
+    Proc.new {
+      interpreter.interpret("foobar toto james anthony krishna", 1, 2, 3)
+    }.should raise_error RuntimeError, "Unable to interpret 'foobar toto james anthony krishna': available commands are say-hello, if-admin, say-bye, tweets"
+
+  end
+end
+
+

data/stringfire.gemspec

@@ -0,0 +1,22 @@
+# -*- coding: utf-8; mode: ruby  -*-
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stringfire/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "stringfire"
+  gem.version       = Stringfire::VERSION
+  gem.authors       = ["Conan Dalton"]
+  gem.email         = ["conan@conandalton.net"]
+  gem.description   = %q{Strip the first token off a string, pass remainder of string as arg to function identified by first token}
+  gem.summary       = "Useful where you want user-supplied executable expressions embedded in your data (in a CMS for example), but for obvious reasons you're not going to let them write ruby code"
+  gem.homepage      = "https://github.com/conanite/stringfire"
+
+  gem.add_development_dependency 'rspec', '~> 2.9'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: stringfire
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Conan Dalton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+description: Strip the first token off a string, pass remainder of string as arg to
+  function identified by first token
+email:
+- conan@conandalton.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/stringfire.rb
+- lib/stringfire/version.rb
+- spec/spec_helper.rb
+- spec/stringfire/interpreter_spec.rb
+- stringfire.gemspec
+homepage: https://github.com/conanite/stringfire
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Useful where you want user-supplied executable expressions embedded in your
+  data (in a CMS for example), but for obvious reasons you're not going to let them
+  write ruby code
+test_files:
+- spec/spec_helper.rb
+- spec/stringfire/interpreter_spec.rb