palimpsest 0.0.1

data/spec/environment_spec.rb

@@ -0,0 +1,305 @@
+require 'spec_helper'
+
+describe Palimpsest::Environment do
+
+  let(:site_1) { double name: 'site_1' }
+  let(:site_2) { double name: 'site_2' }
+
+  subject(:environment) { Palimpsest::Environment.new }
+
+  after :all do
+    Dir.glob("#{Palimpsest::Environment.new.options[:tmp_dir]}/#{Palimpsest::Environment.new.options[:dir_prefix]}*").each do |dir|
+      FileUtils.remove_entry_secure dir
+    end
+  end
+
+  describe ".new" do
+
+    it "sets default options" do
+      expect(environment.options).to eq Palimpsest::Environment::DEFAULT_OPTIONS
+    end
+
+    it "merges default options" do
+      environment = Palimpsest::Environment.new options: { tmp_dir: '/tmp/path' }
+      expect(environment.options).to eq Palimpsest::Environment::DEFAULT_OPTIONS.merge(tmp_dir: '/tmp/path')
+    end
+  end
+
+  describe "#options" do
+
+    it "merges with default options" do
+      environment.options[:tmp_dir] = '/tmp/path'
+      expect(environment.options).to eq Palimpsest::Environment::DEFAULT_OPTIONS.merge(tmp_dir: '/tmp/path')
+    end
+
+    it "can be called twice and merge options" do
+      environment.options[:tmp_dir] = '/tmp/path'
+      environment.options[:dir_prefix] = '/tmp/path'
+      expect(environment.options).to eq Palimpsest::Environment::DEFAULT_OPTIONS.merge(tmp_dir: '/tmp/path', dir_prefix: '/tmp/path')
+    end
+  end
+
+  describe "#site" do
+
+    it "cannot be redefinfed while populated" do
+      environment.site = site_1
+      allow(environment).to receive(:populated).and_return(true)
+      expect { environment.site = site_2 }.to raise_error RuntimeError, /populated/
+    end
+  end
+
+  describe "#treeish" do
+
+    it "must be a string" do
+      expect { environment.treeish = 1 }.to raise_error TypeError
+    end
+
+    it "cannot be redefinfed while populated" do
+      environment.treeish = 'treeish_1'
+      allow(environment).to receive(:populated).and_return(true)
+      expect { environment.treeish = 'treeish_2' }.to raise_error RuntimeError, /populated/
+    end
+  end
+
+  describe "#directory" do
+
+    context "when required values set" do
+
+      subject(:environment) { Palimpsest::Environment.new site: site_1 }
+
+      before :each do
+        allow(Palimpsest::Utility).to receive(:make_random_directory).and_return('/tmp/rand_dir')
+      end
+
+      context "when directory is unset" do
+
+        it "makes and returns a random directory" do
+          expect(environment.directory).to eq '/tmp/rand_dir'
+        end
+      end
+
+      context "when directory is set" do
+
+        it "returns the current directory" do
+          expect(Palimpsest::Utility).to receive(:make_random_directory).once
+          environment.directory
+          expect(environment.directory).to eq '/tmp/rand_dir'
+        end
+      end
+    end
+
+    context "when required values are not set" do
+
+      it "fails if site is not set" do
+        expect { environment.directory }.to raise_error RuntimeError
+      end
+    end
+  end
+
+  describe "#cleanup" do
+
+    subject(:environment) { Palimpsest::Environment.new site: site_1 }
+
+    it "removes the directory and resets @directory" do
+      environment.directory
+      FileUtils.should_receive(:remove_entry_secure).with(environment.directory)
+      environment.cleanup
+      expect(environment.instance_variable_get :@directory).to eq nil
+    end
+  end
+
+  describe "#populate" do
+
+    it "fails when missing site" do
+      environment.treeish = 'master'
+      expect { environment.populate }.to raise_error RuntimeError, /populate without/
+    end
+
+    context "populate from repo" do
+
+      subject(:environment) { Palimpsest::Environment.new site: site_1, treeish: 'master' }
+
+      before :each do
+        allow(site_1).to receive(:repo).and_return(double Grit::Repo)
+        allow(Palimpsest::Utility).to receive :extract_repo
+      end
+
+      it "extracts the repo to the directory and sets populated true" do
+        expect(Palimpsest::Utility).to receive(:extract_repo).with(site_1.repo, 'master', environment.directory)
+        environment.populate
+        expect(environment.populated).to eq true
+      end
+
+      it "fails when missing treeish" do
+        environment.site = site_1
+        environment.treeish = ''
+        expect { environment.populate }.to raise_error RuntimeError, /populate without/
+      end
+
+      it "returns itself" do
+        expect(environment.populate).to be environment
+      end
+
+      it "will cleanup if populated" do
+        environment.populate
+        expect(environment).to receive :cleanup
+        environment.populate
+      end
+    end
+
+    context "populate from directory" do
+
+      it "copies the source files to the directory" do
+        environment.site = site_1
+        allow(site_1).to receive(:source).and_return('/path/to/source')
+        allow(Dir).to receive(:[]).with('/path/to/source/*').and_return( %w(dir_1 dir_2) )
+        expect(FileUtils).to receive(:cp_r).with( %w(dir_1 dir_2), environment.directory )
+        environment.populate from: :source
+      end
+    end
+  end
+
+  describe "config" do
+
+    subject(:environment) { Palimpsest::Environment.new site: site_1, treeish: 'master' }
+
+    before :each do
+      allow(YAML).to receive(:load_file)
+    end
+
+    it "populate if not populated" do
+      expect(environment).to receive :populate
+      environment.config
+    end
+
+    it "populate only if not populated" do
+      allow(environment).to receive(:populated).and_return(true)
+      expect(environment).not_to receive :populate
+      environment.config
+    end
+
+    it "loads the config if populated" do
+      allow(environment).to receive(:populated).and_return(true)
+      expect(YAML).to receive(:load_file).with("#{environment.directory}/palimpsest_config.yml")
+      environment.config
+    end
+  end
+
+  describe "methods that modify the working directory" do
+
+    let(:config) do
+      YAML.load <<-EOF
+        :assets:
+          :options:
+            :output: compiled
+            :src_pre: "(%"
+          :sources:
+            - public
+            - app/src
+          :javascripts:
+            :options:
+              :js_compressor: :uglifier
+              :gzip: true
+            :paths:
+              - assets/javascripts
+              - other/javascripts
+          :stylesheets:
+            :options:
+              :output: css
+              :css_compressor: :sass
+            :paths:
+              - assets/stylesheets
+      EOF
+    end
+
+    before :each do
+      environment.site = site_1
+      environment.directory
+      allow(environment).to receive(:populated).and_return(true)
+      allow(environment).to receive(:config).and_return(config)
+    end
+
+    describe "#assets" do
+
+      subject(:assets) { environment.assets }
+
+      it "returns an array" do
+        expect(assets).to be_a Array
+      end
+
+      it "returns an array of asset objects" do
+        expect(assets[0]).to be_a Palimpsest::Assets
+        expect(assets[1]).to be_a Palimpsest::Assets
+      end
+
+      it "sets the directory for each asset" do
+        expect(assets[0].directory).to eq environment.directory
+        expect(assets[1].directory).to eq environment.directory
+      end
+
+      it "sets the options for each asset" do
+        expect(assets[0].options).to include output: 'compiled'
+        expect(assets[0].options).to include js_compressor: :uglifier
+        expect(assets[0].options).to include gzip: true
+        expect(assets[1].options).to include output: 'css'
+        expect(assets[1].options).to include css_compressor: :sass
+      end
+
+      it "sets the paths for each asset" do
+        expect(assets[0].paths).to include 'assets/javascripts'
+        expect(assets[0].paths).to include 'other/javascripts'
+        expect(assets[1].paths).to include 'assets/stylesheets'
+      end
+
+      it "only loads the paths for each type of asset" do
+        expect(assets[0].paths).to_not include 'assets/stylesheets'
+        expect(assets[1].paths).to_not include 'assets/javascripts'
+      end
+
+      it "does not fail if assets are not configured" do
+        allow(environment).to receive(:config).and_return({})
+        expect { assets }.not_to raise_error
+      end
+    end
+
+    describe "#sources_with_assets" do
+
+      let(:dir) { environment.directory }
+
+      it "looks for all asset types" do
+        expect(Palimpsest::Assets).to receive(:find_tags).twice.with(anything, nil, anything)
+        environment.sources_with_assets
+      end
+
+      it "uses options as options" do
+        expect(Palimpsest::Assets).to receive(:find_tags).twice.with(anything, anything, { src_pre: '(%' } )
+        environment.sources_with_assets
+      end
+
+      it "returns assets with tags" do
+        allow(Palimpsest::Assets).to receive(:find_tags).with(dir + '/public', anything, anything).and_return(dir + '/public/header.html')
+        allow(Palimpsest::Assets).to receive(:find_tags).with(dir + '/app/src', anything, anything).and_return(dir + '/app/src/head.tpl')
+        expect(environment.sources_with_assets).to eq [ "#{dir}/public/header.html", "#{dir}/app/src/head.tpl" ]
+      end
+    end
+
+    describe "#compile_assets" do
+
+      let(:sources) { [ "#{environment.directory}/public/header.html", "#{environment.directory}/app/src/head.tpl" ] }
+
+      it "returns itself" do
+        allow(environment).to receive(:sources_with_assets).and_return([])
+        expect(environment.compile_assets).to be environment
+      end
+
+      it "compiles the assets and writes the sources" do
+        allow(environment).to receive(:sources_with_assets).and_return sources
+        allow(File).to receive(:read).with(sources[0]).and_return('data_1')
+        allow(File).to receive(:read).with(sources[1]).and_return('data_2')
+        expect(Palimpsest::Utility).to receive(:write).with 'data_1', sources[0]
+        expect(Palimpsest::Utility).to receive(:write).with 'data_2', sources[1]
+        environment.compile_assets
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'palimpsest'
+
+require 'coveralls'
+require 'simplecov'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+
+SimpleCov.start
+
+RSpec.configure do |c|
+  c.expect_with(:rspec) { |e| e.syntax = :expect }
+end

data/spec/utility_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe Palimpsest::Utility do
+
+  describe ".make_random_directory" do
+
+    root, prefix = '/tmp', 'rspec'
+
+    it "makes a directory where expected" do
+      dir = Palimpsest::Utility.make_random_directory root, prefix
+      expect(Dir.exists? dir).to be_true
+      FileUtils.remove_entry_secure dir if dir =~ %r{^/tmp}
+    end
+  end
+
+  describe ".validate_path" do
+
+    context "valid path" do
+
+      it "returns the input path" do
+        expect(Palimpsest::Utility.validate_path '/path').to eq '/path'
+      end
+
+      it "returns the input path when the root path matches" do
+        expect(Palimpsest::Utility.validate_path '/path/to/dir', '/path/to').to eq '/path/to/dir'
+      end
+
+    end
+
+    context "bad path" do
+
+      it "rasises an error if path contains '../'" do
+        expect { Palimpsest::Utility.validate_path 'path/with/../in/it' }.to raise_error RuntimeError
+      end
+
+      it "rasises an error if using '~/'" do
+        expect { Palimpsest::Utility.validate_path '~/path' }.to raise_error RuntimeError
+      end
+
+      it "rasises an error if given root does not match path root" do
+        expect { Palimpsest::Utility.validate_path '/other_root/path', '/root/path' }.to raise_error RuntimeError
+      end
+    end
+  end
+
+  describe "write" do
+
+    let(:file) { double File }
+
+    it "writes to file" do
+      allow(File).to receive(:open).with('path/to/file', 'w').and_yield(file)
+      expect(file).to receive(:write).with('data')
+      Palimpsest::Utility.write 'data', 'path/to/file'
+    end
+  end
+end

metadata

@@ -0,0 +1,297 @@
+--- !ruby/object:Gem::Specification
+name: palimpsest
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Evan Boyd Sosenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: archive-tar-minitar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+- !ruby/object:Gem::Dependency
+  name: grit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: bump
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.7.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.7.2
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.5
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: guard-yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description: 'No web framework, no problem: Palimpsest gives any custom or legacy
+  project a modern workflow and toolset.'
+email:
+- razorx@evansosenko.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".kateproject"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/palimpsest.rb
+- lib/palimpsest/assets.rb
+- lib/palimpsest/environment.rb
+- lib/palimpsest/utility.rb
+- lib/palimpsest/version.rb
+- palimpsest.gemspec
+- spec/assets_spec.rb
+- spec/environment_spec.rb
+- spec/spec_helper.rb
+- spec/utility_spec.rb
+homepage: https://github.com/razor-x/palimpsest
+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.0.3
+signing_key: 
+specification_version: 4
+summary: 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.
+test_files:
+- spec/assets_spec.rb
+- spec/environment_spec.rb
+- spec/spec_helper.rb
+- spec/utility_spec.rb
+has_rdoc: