m4assets 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.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/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rake'
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Tobias Svensson
+
+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.rdoc

@@ -0,0 +1,92 @@
+= M4Assets
+
+Sprockets support for the {M4}[http://www.gnu.org/software/m4/] preprocessor.
+
+---
+
+M4Assets adds support for the GNU {M4}[http://www.gnu.org/software/m4/] general
+purpose macro processor to sprockets, allowing you to use textual macros in eg.
+your JavaScript, CoffeeScript, CSS or SCSS code.
+
+== Installation
+
+The best way to install M4Assets is with RubyGems:
+
+  $ [sudo] gem install m4assets
+
+Or add it to your Gemfile:
+
+  gem 'm4assets'
+
+And then execute:
+
+  $ bundle install
+
+If you're installing from source, you can use Bundler to pick up all the gems,
+including those required for running the tests and creating coverage reports:
+
+  $ bundle install
+
+Consult the online documentation for more information on
+{Bundler}[http://gembundler.com/]
+
+== Dependencies
+
+* {Sprockets}[http://github.com/sstephenson/sprockets]
+
+== Getting started
+
+M4Assets uses +which+ to configure itself. You may, however, override the
+auto-detected location of the m4 binary:
+
+  M4Assets.configure do |config|
+    config.path = "/path/to/m4"
+  end
+
+Next you need to register M4Assets. If you are using Rails and you want to
+use m4 macros in your JavaScript code, you would create the following
+initializer:
+
+  Rails.application.assets.register_preprocessor 'application/javascript',
+    M4Assets::Processor
+
+== Contributing
+
+If you'd like to contribute to Tweedle, start by forking the repo on GitHub:
+
+{http://github.com/tobiassvn/m4assets}[http://github.com/tobiassvn/m4assets]
+
+To get all of the dependencies, install the gem first. The best way to
+getyour changes merged back into core is as follows:
+
+* Clone down your fork.
+* Create a thoughtfully named topic branch to contain your change.
+* Hack away.
+* Add tests and make sure everything still passes by running rake.
+* If you are adding new functionality, document it in the README.
+* Do not change the version number, I will do that on my end.
+* If necessary, rebase your commits into logical chunks, without errors
+* Push the branch up to GitHub
+* Send a pull request to the tobiassvn/m4assets project.
+
+== License
+
+  Copyright (c) 2012 Tobias Svensson.
+
+  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/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/test_*.rb"
+end
+
+task :default => :test

data/lib/m4assets/error.rb

@@ -0,0 +1,5 @@
+module M4Assets
+  class Error < StandardError
+  end
+end
+

data/lib/m4assets/processor.rb

@@ -0,0 +1,19 @@
+module M4Assets
+  class Processor < Sprockets::Processor
+    def evaluate(context, locals)
+      stdin, stdout, stderr, wait_thr = Open3.popen3(M4Assets.config.path)
+      stdin.puts(data)
+      stdin.close
+
+      # Exit status is 0 for success, 1 for failure, 63 for frozen file version
+      # mismatch, or whatever value was passed to the m4exit macro.
+      if exitstatus = wait_thr.value.exitstatus != 0
+        raise Error.new("m4 exit status #{exitstatus}. stderr: #{stderr.read}")
+      end
+
+      # Trim dangling newline.
+      stdout.read[0..-2]
+    end
+  end
+end
+

data/lib/m4assets/version.rb

@@ -0,0 +1,3 @@
+module M4Assets
+  VERSION = '0.1.0'
+end

data/lib/m4assets.rb

@@ -0,0 +1,20 @@
+require 'sprockets'
+require 'open3'
+require 'm4assets/version'
+require 'm4assets/error'
+require 'm4assets/processor'
+
+module M4Assets
+  class << self
+    attr_writer :config
+
+    def configure
+      yield config
+    end
+
+    def config
+      @config ||= OpenStruct.new(path: `which m4`)
+    end
+  end
+end
+  

data/m4assets.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'm4assets/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "m4assets"
+  gem.version       = M4Assets::VERSION
+  gem.authors       = ["Tobias Svensson"]
+  gem.email         = ["tob@tobiassvensson.co.uk"]
+  gem.description   = "Sprockets support for the M4 preprocessor"
+  gem.summary       = gem.description
+  gem.homepage      = "http://github.com/tobiassvn/m4assets"
+
+  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"]
+
+  gem.add_runtime_dependency "sprockets"
+end

data/test/helper.rb

@@ -0,0 +1,2 @@
+require 'minitest/autorun'
+require 'm4assets'

data/test/test_config.rb

@@ -0,0 +1,20 @@
+require_relative 'helper'
+
+class TestConfig < MiniTest::Unit::TestCase
+  def setup
+    @old_config = M4Assets.config.dup
+  end
+
+  def teardown
+    M4Assets.config = @old_config
+  end
+
+  def test_configure
+    M4Assets.configure do |config|
+      config.path = 'foo'
+    end
+
+    assert_equal M4Assets.config.path, 'foo'
+  end
+end
+

data/test/test_processor.rb

@@ -0,0 +1,39 @@
+require_relative 'helper'
+
+class TestProcessor < MiniTest::Unit::TestCase
+  class Context
+    attr_accessor :logical_path
+
+    def initialize(lpath)
+      @logical_path = lpath
+    end
+  end
+
+  def context
+    Context.new('/assets/javascripts/test.coffee.m4')
+  end
+
+  def process(string)
+    processor = M4Assets::Processor.new { string }
+    processor.evaluate(context, {})
+  end
+
+  def test_empty_data
+    assert_equal '', process('')
+  end
+
+  def test_string
+    assert_equal 'test', process('test')
+  end
+
+  def test_macro
+    assert_equal '5', process('incr(4)')
+  end
+
+  def test_error_handling
+    assert_raises(M4Assets::Error) do
+      process('m4exit(1)')
+    end
+  end
+end
+

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: m4assets
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Tobias Svensson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  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: Sprockets support for the M4 preprocessor
+email:
+- tob@tobiassvensson.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- lib/m4assets.rb
+- lib/m4assets/error.rb
+- lib/m4assets/processor.rb
+- lib/m4assets/version.rb
+- m4assets.gemspec
+- test/helper.rb
+- test/test_config.rb
+- test/test_processor.rb
+homepage: http://github.com/tobiassvn/m4assets
+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.23
+signing_key: 
+specification_version: 3
+summary: Sprockets support for the M4 preprocessor
+test_files:
+- test/helper.rb
+- test/test_config.rb
+- test/test_processor.rb