palimpsest 0.0.1

data/lib/palimpsest/utility.rb

@@ -0,0 +1,69 @@
+require 'archive/tar/minitar'
+
+module Palimpsest
+
+  # Utility functions for Palimpsest.
+  class Utility
+
+    # Make a random directory.
+    # @param [String] root directory to place random directory
+    # @param [String] prefix prepended to random directory name
+    # @param [String, nil] dir the random directory name (used recursively)
+    # @return [String] path to created random directory
+    def self.make_random_directory root, prefix, dir = nil
+      path = "#{root}/#{prefix}#{dir}" unless dir.nil?
+      if path.nil? or File.exists? path
+        make_random_directory root, prefix, Random.rand(10000000)
+      else
+        FileUtils.mkdir(path).first
+      end
+    end
+
+    # Forbids use of `../` and `~/` in path.
+    # Forbids absolute paths.
+    # @param [String] path
+    # @return [Boolean]
+    def self.safe_path? path
+      case
+      when path[/(\.\.\/|~\/)/] then return false
+      when path[/^\//] then return false
+      else return true
+      end
+    end
+
+    # Checks that a path is really rooted under a given root directory.
+    # Forbids use of `../` and `~/` in path.
+    # @param [String] path
+    # @param [String] root directory where path should be rooted under
+    # @return [String] input path if valid
+    def self.validate_path path, root=''
+      case
+      when path[/(\.\.\/|~\/)/] then raise RuntimeError
+      when File.expand_path(path, root)[/^#{root}/].nil? then raise RuntimeError
+      else path
+      end
+    end
+
+    # Extracts a git repo to a directory.
+    # @param [Grit::Repo] repo
+    # @param [String] treeish
+    # @param [String] directory
+    def self.extract_repo repo, treeish, directory, files: nil
+      input = Archive::Tar::Minitar::Input.new StringIO.new(repo.archive_tar treeish)
+      input.each do |entry|
+        if files.nil?
+          input.extract_entry directory, entry
+        else
+          input.extract_entry directory, entry if files.include? entry.name
+        end
+      end
+    end
+
+    # Write contents to file.
+    # @param contents [String]
+    # @param file [String]
+    def self.write contents, file
+      File.open(file, 'w') { |f| f.write contents }
+    end
+  end
+end

data/lib/palimpsest/version.rb

@@ -0,0 +1,4 @@
+module Palimpsest
+  # Palimpsest version.
+  VERSION = '0.0.1'
+end

data/lib/palimpsest.rb

@@ -0,0 +1,9 @@
+require 'palimpsest/version'
+require 'palimpsest/assets'
+require 'palimpsest/environment'
+require 'palimpsest/utility'
+
+# No web framework, no problem:
+# Palimpsest gives any custom or legacy project # a modern workflow and toolset.
+module Palimpsest
+end

data/palimpsest.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'palimpsest/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'palimpsest'
+  spec.version       = Palimpsest::VERSION
+  spec.authors       = ['Evan Boyd Sosenko']
+  spec.email         = ['razorx@evansosenko.com']
+  spec.description   = %q{No web framework, no problem: Palimpsest gives any custom or legacy project a modern workflow and toolset.}
+  spec.summary       = %q{Built flexible, simple, and customizable. Palimpsest runs on top of any project and acts as a post processor for your code. Features a Sprockets asset pipeline and easy integration with Kit.}
+  spec.homepage      = 'https://github.com/razor-x/palimpsest'
+  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_dependency 'activesupport', '~> 4.0.0'
+  spec.add_dependency 'archive-tar-minitar', '~> 0.5.2'
+  spec.add_dependency 'grit', '~> 2.5.0'
+  spec.add_dependency 'sprockets', '~> 2.10.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.1'
+  spec.add_development_dependency 'bump', '~> 0.4'
+
+  spec.add_development_dependency 'yard', '0.8.7.2'
+  spec.add_development_dependency 'redcarpet', '3.0.0'
+  spec.add_development_dependency 'github-markup', '0.7.5'
+
+  spec.add_development_dependency 'rspec', '~> 2.14.1'
+  spec.add_development_dependency 'simplecov', '~> 0.7.1'
+  spec.add_development_dependency 'coveralls', '~> 0.7.0'
+  spec.add_development_dependency 'fuubar', '~> 1.2.1'
+  spec.add_development_dependency 'guard-rspec', '~> 3.1.0'
+  spec.add_development_dependency 'guard-yard', '~> 2.1.0'
+end

data/spec/assets_spec.rb

@@ -0,0 +1,360 @@
+require 'spec_helper'
+
+describe Palimpsest::Assets do
+
+  let(:config) do
+    YAML.load <<-EOF
+      :options:
+        :js_compressor: :uglifier
+        :not_a_good_setting: :some_value
+      :paths:
+        - assets/javascripts
+        - other/javascripts
+    EOF
+  end
+
+  subject(:assets) { Palimpsest::Assets.new }
+
+  describe ".new" do
+
+    it "sets default options" do
+      expect(assets.options).to eq Palimpsest::Assets::DEFAULT_OPTIONS
+    end
+
+    it "merges default options" do
+      assets = Palimpsest::Assets.new options: { src_pre: '{{' }
+      expect(assets.options).to eq Palimpsest::Assets::DEFAULT_OPTIONS.merge(src_pre: '{{')
+    end
+  end
+
+  describe "#options" do
+
+    it "merges with default options" do
+      assets.options[:src_pre] = '{{'
+      expect(assets.options).to eq Palimpsest::Assets::DEFAULT_OPTIONS.merge(src_pre: '{{')
+    end
+
+    it "can be called twice and merge options" do
+      assets.options[:src_pre] = '{{'
+      assets.options[:src_post] = '}}'
+      expect(assets.options).to eq Palimpsest::Assets::DEFAULT_OPTIONS.merge(src_pre: '{{', src_post: '}}')
+    end
+  end
+
+  describe "#sprockets" do
+
+    it "returns a new sprockets environment" do
+      expect(assets.sprockets).to be_a Sprockets::Environment
+    end
+  end
+
+  describe "#load_options" do
+
+    subject(:assets) { Palimpsest::Assets.new options: config[:options] }
+
+    it "returns itself" do
+      expect(assets.load_options).to be assets
+    end
+
+    it "sets the options for sprockets" do
+      expect(assets.sprockets).to receive(:js_compressor=).with(:uglifier)
+      assets.load_options
+    end
+
+    it "does not load an unset setting" do
+      expect(assets.sprockets).to_not receive(:css_compressor)
+      assets.load_options
+    end
+
+    it "does not load an invalid setting" do
+      expect(assets.sprockets).to_not receive(:not_a_good_setting)
+      assets.load_options
+    end
+
+    context "no options" do
+
+      it "does not fail when options not set" do
+        expect { assets.load_options }.to_not raise_error
+      end
+    end
+  end
+
+  describe "#load_paths" do
+
+    subject(:assets) { Palimpsest::Assets.new paths: config[:paths] }
+
+    it "returns itself" do
+      expect(assets.load_paths).to be assets
+    end
+
+    context "when directory set" do
+
+      it "loads the paths for the given set into the sprockets environment" do
+        assets.directory = '/tmp/root_dir'
+        expect(assets.sprockets).to receive(:append_path).with('/tmp/root_dir/assets/javascripts')
+        expect(assets.sprockets).to receive(:append_path).with('/tmp/root_dir/other/javascripts')
+        assets.load_paths
+      end
+    end
+
+    context "when no directory set" do
+
+      it "loads the paths for the given set into the sprockets environment" do
+        expect(assets.sprockets).to receive(:append_path).with('assets/javascripts')
+        expect(assets.sprockets).to receive(:append_path).with('other/javascripts')
+        assets.load_paths
+      end
+    end
+
+    context "when no paths set" do
+
+      it "should not fail" do
+        assets.paths = {}
+        expect { assets.load_paths }.to_not raise_error
+      end
+    end
+  end
+
+  describe "#assets" do
+
+    subject(:assets) { Palimpsest::Assets.new paths: config[:paths] }
+
+    it "should load options" do
+      expect(assets).to receive :load_options
+      assets.assets
+    end
+
+    it "should load paths" do
+      expect(assets).to receive :load_paths
+      assets.assets
+    end
+
+    it "should not load options and paths twice" do
+      expect(assets).to receive(:load_options).once
+      expect(assets).to receive(:load_paths).once
+      assets.assets
+      assets.assets
+    end
+
+    it "should return compiled assets" do
+      expect(assets.assets).to equal assets.sprockets
+    end
+  end
+
+  describe "#write" do
+
+    let(:asset) { double Sprockets::Asset }
+    let(:name) { 'lib/app.js' }
+
+    before :each do
+      assets.options hash: false
+      allow(assets.assets).to receive(:[]).with('lib/app').and_return(asset)
+      allow(asset).to receive(:logical_path).and_return(name)
+    end
+
+    context "asset not found" do
+      it "returns nil" do
+        allow(assets.assets).to receive(:[]).with('not_here').and_return(nil)
+        expect(assets.write 'not_here').to be nil
+      end
+    end
+
+    context "output is set with no directory set" do
+
+      it "writes to relative path and returns the relative path" do
+        assets.options output: 'compiled'
+        expect(asset).to receive(:write_to).with("compiled/#{name}")
+        expect(assets.write 'lib/app').to eq "compiled/#{name}"
+      end
+    end
+
+    context "output is set with directory set" do
+
+      it "writes to relative path under directory and returns the relative path" do
+        assets.options output: 'compiled'
+        assets.directory = '/tmp/dir'
+        expect(asset).to receive(:write_to).with("/tmp/dir/compiled/#{name}")
+        expect(assets.write 'lib/app').to eq "compiled/#{name}"
+      end
+    end
+
+    context "no output is set with directory set and returns the relative path" do
+
+      it "writes to relative path under directory and returns the relative path" do
+        assets.directory = '/tmp/dir'
+        expect(asset).to receive(:write_to).with("/tmp/dir/#{name}")
+        expect(assets.write 'lib/app').to eq name
+      end
+    end
+
+    context "no output is set with no directory set" do
+
+      it "writes to relative path and returns the relative path" do
+        expect(asset).to receive(:write_to).with(name)
+        expect(assets.write 'lib/app').to eq name
+      end
+    end
+
+    context "when gzip true" do
+
+      it "still returns the non-gzipped asset name" do
+        allow(asset).to receive(:write_to)
+        expect(assets.write 'lib/app', gzip: true).to eq name
+      end
+
+      it "it gzips the assets as well" do
+        expect(asset).to receive(:write_to).at_most(:once).with("#{name}.gz", compress: true)
+        expect(asset).to receive(:write_to).at_most(:once).with(name)
+        assets.write 'lib/app', gzip: true
+      end
+    end
+
+    context "when hash true" do
+
+      it "hashes the file name" do
+        allow(asset).to receive(:digest_path).and_return('app-cb5a921a4e7663347223c41cd2fa9e11.js')
+        expect(asset).to receive(:write_to).with('app-cb5a921a4e7663347223c41cd2fa9e11.js')
+        assets.write 'lib/app', hash: true
+      end
+    end
+  end
+
+  describe ".find_tags and #find_tags" do
+
+    let(:grep) { [ 'grep', '-l', '-I', '-r', '-E' ] }
+    let(:matches) { [ "first/match_1\nsecond/match_2" ] }
+
+    describe ".find_tags" do
+
+      let(:regex) { '\[%(.*?)%\]' }
+
+      it "fails if path is empty" do
+        expect { assets.find_tags '' }.to raise_error ArgumentError
+      end
+
+      it "greps in the path" do
+        expect(Open3).to receive(:capture2).with(*grep, regex, '/the/path').and_return(matches)
+        Palimpsest::Assets.find_tags '/the/path'
+      end
+
+      it "greps for only the asset tag for the given type" do
+        expect(Open3).to receive(:capture2).with(*grep, '\[%\s+javascript\s+(.*?)%\]', '/the/path').and_return(matches)
+        Palimpsest::Assets.find_tags '/the/path', :javascript
+      end
+
+      it "merges options" do
+        expect(Open3).to receive(:capture2).with(*grep, '\(%\s+javascript\s+(.*?)%\]', '/the/path').and_return(matches)
+        Palimpsest::Assets.find_tags '/the/path', :javascript, src_pre: '(%'
+      end
+
+      it "returns an array of results" do
+        allow(Open3).to receive(:capture2).with(*grep, regex, '/the/path').and_return(matches)
+        expect(Palimpsest::Assets.find_tags '/the/path').to eq [ 'first/match_1', 'second/match_2' ]
+      end
+    end
+
+    describe "#find_tags" do
+
+      it "uses the type as the type" do
+        assets.type = :javascript
+        expect(Palimpsest::Assets).to receive(:find_tags).with(anything, :javascript, anything)
+        assets.find_tags path: '/the/path'
+      end
+
+      it "uses the options as the options" do
+        expect(Palimpsest::Assets).to receive(:find_tags).with(anything, anything, assets.options)
+        assets.find_tags path: '/the/path'
+      end
+
+      it "uses the directory as the path" do
+        assets.directory = '/the/directory'
+        expect(Palimpsest::Assets).to receive(:find_tags).with('/the/directory', anything, anything)
+        assets.find_tags
+      end
+
+      it "can use an alternative path" do
+        assets.directory = '/the/directory'
+        expect(Palimpsest::Assets).to receive(:find_tags).with('/the/path', anything, anything)
+        assets.find_tags path: '/the/path'
+      end
+    end
+  end
+
+  describe "#update_source and #update_source!" do
+
+    let(:asset) { double Sprockets::Asset }
+
+    let(:source) do
+      <<-EOF
+        <head>
+          <script src="[% javascript app %]"></script>
+          <script src="[% javascript vendor/modernizr %]"></script>
+          <script>
+            [% javascript inline vendor/tracking %]
+          </script>
+        </head>
+      EOF
+    end
+
+    let(:result) do
+      <<-EOF
+        <head>
+          <script src="app-1234.js"></script>
+          <script src="vendor/modernizr-5678.js"></script>
+          <script>
+            alert('track');
+          </script>
+        </head>
+      EOF
+    end
+
+    let(:result_with_cdn) do
+      <<-EOF
+        <head>
+          <script src="https://cdn.example.com/app-1234.js"></script>
+          <script src="https://cdn.example.com/vendor/modernizr-5678.js"></script>
+          <script>
+            alert('track');
+          </script>
+        </head>
+      EOF
+    end
+
+    before :each do
+      assets.type = :javascripts
+      allow(assets).to receive(:write).with('app').and_return('app-1234.js')
+      allow(assets).to receive(:write).with('vendor/modernizr').and_return('vendor/modernizr-5678.js')
+      allow(assets.assets).to receive(:[]).with('vendor/tracking').and_return(asset)
+      allow(asset).to receive(:to_s).and_return(%q{alert('track');})
+    end
+
+    describe "#update_source!" do
+
+      it "replaces asset tags in sources" do
+        assets.update_source! source
+        expect(source).to eq result
+      end
+
+      context "cdn option set" do
+
+        it "uses cdn when it replaces asset tags in sources" do
+          assets.options cdn: 'https://cdn.example.com/'
+          assets.update_source! source
+          expect(source).to eq result_with_cdn
+        end
+      end
+    end
+
+    describe "#update_source" do
+
+      it "replaces asset tags in sources" do
+        expect(assets.update_source source).to eq result
+      end
+
+      it "does not change input string" do
+        assets.update_source source
+        expect(source).to eq source
+      end
+    end
+  end
+end