smelter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c9365372b5d0b36b5e219c4d6585ea1b3d95ae74
+  data.tar.gz: 9bef443700491ec4e2c9e4be8f091b1bfb9796a2
+SHA512:
+  metadata.gz: 54818a4ebce7782d880ddfbe72819e5857c56a31a8291351d6abb07c57629e76320e3e36c3a680d8c35db1eb98ae650262dd8849cdef5fe41e74d2db003a2706
+  data.tar.gz: 8c90fc55b6e7658b0d638d7a0bea14d70360ca2ef72dcb886896a20c31d683e3f174875f384f84f8ad49093d5b36e041a4cd523fbd1511bae31d7b059d66cef9

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jon Stokes
+
+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,135 @@
+# Smelter
+
+Smelter is a small gem that has a pretty specific use case. You can store
+scripts and extensions in a data store (redis, postgres, or anything else)
+and then use that stored code to dynamically mutate a shared context.
+
+All of the caveats around `context_eval`ing some code from a data store apply.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'smelter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install smelter
+
+## Usage
+
+The classes in `spec/support/test_classes.rb` and the specs will tell you all you
+need to know about how this works. But here's an overview, with code from the specs.
+
+Consider the following extension and script:
+
+```ruby
+  Test::Extension.define "test/my_extension" do
+    extension do
+      def subtract(a, b)
+        a - b
+      end
+    end
+  end
+
+  Test::Script.define "test/my_script" do
+    extensions 'test/*'
+
+    script do
+      number do |context|
+        context['number'] * 10
+      end
+
+      subtraction_result do |context|
+        subtract(context['number'], 1)
+      end
+    end
+  end
+```
+
+Now imagine that the extension and script above are stored in some data store,
+like redis or postgres. You then can do something like the following:
+
+```ruby
+  # Find the script by name in the database, and get a ScriptRunner
+  # object that has the script's extensions defined on it.
+  runner = Test::Script.runner("test/my_script")
+
+  # Prepare a context Hash (or Struct) that the script can mutate
+  # by running the Procs associated with each context attribute from
+  # top to bottom.
+  context = { 'number' => 5 }
+
+  # Mutate the context by running the script on it.
+  runner.run(context)
+
+  # Results!
+  context
+  #=> { 'number' => 50, 'subtraction_result' => 49 }
+```
+
+Like I said, a pretty specific use case.
+
+Stretched.io uses uses this code to prepare JSON objects from web pages
+by extracting different attributes using [Nokogiri](http://nokogiri.org) and the [Buzzsaw DSL](http://github.com/jonstokes/buzzsaw.git).
+
+Here's some actual code that I use with Stretched:
+
+```ruby
+Stretched::Script.define "globals/scripts/product_page" do
+  extensions 'globals/extensions/*'
+
+  script do
+    title do |context|
+      next unless context['title'].present?
+      context['title'].squeeze(' ')
+    end
+
+    availability do |context|
+      if %w(AuctionListing ClassifiedListing).include?(context['type'])
+        "in_stock"
+      else
+        context['availability'].try(:downcase)
+      end
+    end
+
+    image do |context|
+      if context['image']
+        clean_up_image_url(context['image'])
+      end
+    end
+
+    price_in_cents do |context|
+      convert_dollars_to_cents(context['price_in_cents'])
+    end
+  end
+end
+```
+For the above, I populate the `context` hash with values extracted from a product
+web page using [buzzsaw](http://github.com/jonstokes/buzzsaw.git) and [nokogiri](http://nokogiri.org). Then I go back over with the script and
+clean up the data in the context hash, which eventually becomes a JSON object
+that the platform enqueues for a user to be able to get the results of a web scrape.
+
+The methods `convert_dollars_to_cents` and `clean_up_image_url` are defined in
+one of the extensions that the script loads under `globals/extensions/*`. Notice
+that the gem uses globbing to find extensions in the total namespace of extensions.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` 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/[USERNAME]/smelter.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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 "smelter"
+
+# 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

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/smelter.rb

@@ -0,0 +1,10 @@
+require "thread_safe"
+require "smelter/version"
+require "smelter/scriptable"
+require "smelter/extendable"
+require "smelter/definition_proxy"
+require "smelter/script_runner"
+
+module Smelter
+  # Your code goes here...
+end

data/lib/smelter/definition_proxy.rb

@@ -0,0 +1,53 @@
+module Smelter
+  class DefinitionProxy
+    attr_reader :script_name
+    attr_reader :extensions
+
+    def initialize(script_name)
+      @script_name = script_name
+    end
+
+    def extensions(glob)
+      @extensions = glob
+    end
+
+    def script(&block)
+      runner = ScriptRunner.new
+
+      # Define all locally registered extensions on this runner instance
+      self.class.extension_class.registry.each_pair do |extension_name, block|
+        next unless matches_extensions_glob?(extension_name.to_s)
+        runner.instance_eval(&block)
+      end
+
+      # Set up runner instance for use
+      if block_given?
+        runner.instance_eval(&block)
+      end
+
+      runner
+    end
+
+    def extension(&block)
+      self.class.extension_class.register(script_name, &block)
+    end
+
+    def self.extension_class=(val)
+      @@extension_class = val
+    end
+
+    def self.extension_class
+      @@extension_class
+    end
+
+    private
+
+    def matches_extensions_glob?(extension_name)
+      if @extensions.is_a?(String)
+        File.fnmatch?(@extensions, extension_name)
+      else
+        @extensions.select { |ext| File.fnmatch?(ext, extension_name) }.any?
+      end
+    end
+  end
+end

data/lib/smelter/extendable.rb

@@ -0,0 +1,49 @@
+module Smelter
+  module Extendable
+
+    # Extendable classes must support the following methods
+    # def self.all_names
+    #   In an ActiveRecord model this could be just pluck(:name)
+    # end
+    #
+    # def name
+    #   returns the name of the script
+    # end
+    #
+    # def source
+    #   returns the source file for the script
+    # end
+
+    def self.included(base)
+      Smelter::DefinitionProxy.extension_class = base
+
+      base.class_eval do
+        extend ClassMethods
+      end
+    end
+
+    def register
+      instance_eval source, name, 1
+    end
+
+    module ClassMethods
+      def register_all
+        self.all_names.each do |name|
+          name = name.to_s
+          next if registry[name]
+          extension = find_by_name(name)
+          extension.register
+        end
+      end
+
+      def registry
+        @registry ||= ThreadSafe::Cache.new
+      end
+
+      def register(extension_name, &block)
+        @registry ||= ThreadSafe::Cache.new
+        @registry[extension_name.to_s] = block
+      end
+    end
+  end
+end

data/lib/smelter/script_runner.rb

@@ -0,0 +1,47 @@
+module Smelter
+  class ScriptRunner
+
+    attr_reader   :attributes, :context
+    attr_accessor :user
+
+    def initialize
+      @attributes = {}
+    end
+
+    def set_context(context)
+      @context = context
+      attrs = @context.is_a?(Hash) ? @context.keys : @context.members
+      attrs.each do |attr|
+        self.define_singleton_method(attr) do
+          @context[attr]
+        end
+      end
+    end
+
+    def run(instance={})
+      attributes.each do |attribute_name, value|
+        result = value.is_a?(Proc) ? value.call(instance) : value
+        instance[attribute_name.to_s] = result
+      end
+      instance
+    end
+
+    def load_registration(opts)
+      opts[:klass].find_by(name: opts[:name])
+    end
+
+    def method_missing(name, *args, &block)
+      if block_given?
+        attributes[name.to_s] = block
+      else
+        attributes[name.to_s] = args[0]
+      end
+    rescue RuntimeError => e
+      if !!e.message[/add a new key into hash during iteration/]
+        super
+      else
+        raise e
+      end
+    end
+  end
+end

data/lib/smelter/scriptable.rb

@@ -0,0 +1,53 @@
+module Smelter
+  module Scriptable
+
+    # Scriptable classes must support the following methods
+    # class Script
+    #   include Smelter::Scriptable
+    #
+    #   runner_include Buzzsaw::DSL
+    #
+    #   def self.find_by_name(name)
+    #     returns a script object
+    #   end
+    #
+    #   def name
+    #     returns the name of the script
+    #   end
+    #
+    #   def source
+    #     returns the source file for the script
+    #   end
+    # end
+
+    def self.included(base)
+      base.class_eval do
+        extend ClassMethods
+      end
+    end
+
+    def register
+      # NOTE: This returns a populated instance of ScriptRunner
+      # that has all extensions defined on it and contains
+      # Procs for the code defined in source
+      instance_eval source, name, 1
+    end
+
+    module ClassMethods
+      def runner_include(mod)
+        Smelter::ScriptRunner.include(mod)
+      end
+
+      def runner(name=nil)
+        return ScriptRunner.new unless name
+        script = find_by_name(name)
+        script.register
+      end
+
+      def define(name, &block)
+        definition_proxy = DefinitionProxy.new(name)
+        definition_proxy.instance_eval(&block)
+      end
+    end
+  end
+end

data/lib/smelter/version.rb

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

data/smelter.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'smelter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "smelter"
+  spec.version       = Smelter::VERSION
+  spec.authors       = ["Jon Stokes"]
+  spec.email         = ["jon@jonstokes.com"]
+
+  spec.summary       = %q{This is the code that stretched.io uses for dynamic scripting. As with anything that calls instance_eval on code from a data store, use cautiously.}
+  spec.homepage      = "http://github.com/jonstokes/smelter.git"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thread_safe"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "redis-objects"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: smelter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jon Stokes
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thread_safe
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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: redis-objects
+  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'
+description: 
+email:
+- jon@jonstokes.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/smelter.rb
+- lib/smelter/definition_proxy.rb
+- lib/smelter/extendable.rb
+- lib/smelter/script_runner.rb
+- lib/smelter/scriptable.rb
+- lib/smelter/version.rb
+- smelter.gemspec
+homepage: http://github.com/jonstokes/smelter.git
+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: This is the code that stretched.io uses for dynamic scripting. As with anything
+  that calls instance_eval on code from a data store, use cautiously.
+test_files: []