palimpsest 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5c5fd7be63cf42172ba38c5aa33e5be3fa92f83
-  data.tar.gz: 79170f2245713ce67b510482b3ad4283817aea95
+  metadata.gz: c91ac2f955b94300ebb7ad20e909bc52289d256c
+  data.tar.gz: dd2e43e3e4a82ae32d5bfd3fefb9d8383554b5b3
 SHA512:
-  metadata.gz: 1fbb3b3b92713de6e71c56cd6d3e296e085cf2968d87ff6300eb0cbbb523735c887b137917df09ffbac9e964c3a55ea657ec57a1ab1b58245de8ba0b11b0191e
-  data.tar.gz: 83ff64c867a93424b6550623dd75a6ef39e9b91440c934f7bcbd85d09fc91eec9df180ed4d249794b722c7ff2f8c5a6b7c4ea0e6805c5ff1be2a4afb51663563
+  metadata.gz: 06229184c2aaeec407d38aa6c8b43f2dc7959e47806fedbabd48499b029eb8d93e72630e920639ceee6e044369a7836cf47620839d46141f49b1ee3cceda9fca
+  data.tar.gz: 9192ff63c9f12c4648e69d4884817340098e51a8381b87c7b5a2de9f4b6af69fea9dfd8892f4ce01ebabd27ba3b8009bb90da37b732e8d9f0c7343dfcfbe4b54

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Palimpsest ChangeLog
 
+## 0.2.0
+
+- Added Environment#remove_excludes.
+- Environment#config can be overridden.
+- Environment#copy now uses rsync to exclude .git.
+
 ## 0.1.0
 
 - Lots of documentation and improvements.

data/lib/palimpsest/environment.rb

@@ -32,9 +32,16 @@ module Palimpsest
   #
   #   # list of external repos
   #   :repos:
-  #   #- [ name, install_path, branch, server (optional) ]
-  #    - [ my_app, apps/my_app, master ]
-  #    - [ sub_app, apps/my_app/sub_app, my_feature, "https://bitbucket.org/razorx" ]
+  #    #- [ name, install_path, branch, server (optional) ]
+  #     - [ my_app, apps/my_app, master ]
+  #     - [ sub_app, apps/my_app/sub_app, my_feature, "https://bitbucket.org/razorx" ]
+  #
+  # # list of excludes
+  # # matching paths are removed with {#remove_excludes}.
+  # :excludes:
+  #   - _assets
+  #   - apps/*/.gitignore
+  #
   # # asset settings
   # :assets:
   #   # all options are passed to Assets#options
@@ -85,7 +92,7 @@ module Palimpsest
   #     :options:
   #       # requires the sprockets-image_compressor gem
   #       :image_compression: true
-  #        # options can be overridden per type
+  #       # options can be overridden per type
   #       :output: images
   #     :paths:
   #       - assets/images
@@ -165,6 +172,7 @@ module Palimpsest
     # @return [Environment] the current environment instance
     def cleanup
       FileUtils.remove_entry_secure directory if @directory
+      @config = nil
       @directory = nil
       @assets = []
       @components = []
@@ -190,18 +198,23 @@ module Palimpsest
         Utility.extract_repo site.repo, treeish, directory
         @populated = true
       when :source
-        FileUtils.cp_r Dir["#{site.source}/*"], directory, preserve: true
+        Kernel.system 'rsync', '-rt', %q{--exclude='.git/'}, "#{site.source}/", directory
         @populated = true
       end
 
       self
     end
 
+    # @param settings [Hash] merged with current config
     # @return [Hash] configuration loaded from {#options}`[:config_file]` under {#directory}
-    def config
-      populate unless populated
-      @config = YAML.load_file "#{directory}/#{options[:config_file]}"
-      validate_config if @config
+    def config settings = {}
+      if @config.nil?
+        populate unless populated
+        @config = YAML.load_file "#{directory}/#{options[:config_file]}"
+        validate_config if @config
+      end
+
+      @config.merge! settings
     end
 
     # @return [Array<Component>] components with paths loaded from config
@@ -252,6 +265,14 @@ module Palimpsest
       self
     end
 
+    # Remove all excludes defined by `config[:excludes]`.
+    # @return [Environment] the current environment instance
+    def remove_excludes
+      return self if config[:excludes].nil?
+      config[:excludes].map{ |e| Dir["#{directory}/#{e}"] }.flatten.each { |e| FileUtils.remove_entry_secure e }
+      self
+    end
+
     # @return [Array<Assets>] assets with settings and paths loaded from config
     def assets
       return @assets if @assets
@@ -319,6 +340,10 @@ module Palimpsest
         end
       end
 
+      @config[:excludes].each do |v|
+        fail RuntimeError, message unless Utility.safe_path? v
+      end unless @config[:excludes].nil?
+
       @config[:external].each do |k, v|
         next if k == :server
 
@@ -369,7 +394,7 @@ module Palimpsest
           # process each asset path
           asset_value.each_with_index do |path, i|
             fail RuntimeError, message unless Utility.safe_path? path
-          end
+          end if asset_key == :paths
         end
       end unless @config[:assets].nil?
 

data/lib/palimpsest/external.rb

@@ -28,6 +28,7 @@ module Palimpsest
       self.install_path = install_path
     end
 
+    # @return [String] full path to repo as {#source}`/`{#name}
     def repo_path
       ( source.empty? || name.empty? ) ? '' : "#{source}/#{name}"
     end

data/lib/palimpsest/utility.rb

@@ -31,19 +31,6 @@ module Palimpsest
       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 fail RuntimeError
-      when File.expand_path(path, root)[/^#{root}/].nil? then fail RuntimeError
-      else path
-      end
-    end
-
     # Extracts a git repo to a directory.
     # @param [Grit::Repo] repo
     # @param [String] treeish
@@ -51,6 +38,7 @@ module Palimpsest
     def self.extract_repo repo, treeish, directory
       input = Archive::Tar::Minitar::Input.new StringIO.new(repo.archive_tar treeish)
       input.each { |e| input.extract_entry directory, e }
+      FileUtils.remove_entry_secure "#{directory}/pax_global_header"
     end
 
     # Write contents to file.

data/lib/palimpsest/version.rb

@@ -1,4 +1,4 @@
 module Palimpsest
   # Palimpsest version.
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/spec/environment_spec.rb

@@ -7,6 +7,10 @@ describe Palimpsest::Environment do
 
   subject(:environment) { Palimpsest::Environment.new }
 
+  before :each do
+    allow(Kernel).to receive(:system)
+  end
+
   describe ".new" do
 
     it "sets default options" do
@@ -149,19 +153,18 @@ describe Palimpsest::Environment do
       it "copies the source files to the directory preserving mtime" do
         environment.site = site_1
         site_1.source = '/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, preserve: true )
+        expect(Kernel).to receive(:system).with('rsync', '-rt', %q{--exclude='.git/'}, '/path/to/source/', environment.directory)
         environment.populate from: :source
       end
     end
   end
 
-  describe "config" do
+  describe "#config" do
 
     subject(:environment) { Palimpsest::Environment.new site: site_1, treeish: 'master' }
 
     before :each do
-      allow(YAML).to receive(:load_file)
+      allow(YAML).to receive(:load_file).and_return({})
     end
 
     it "populate if not populated" do
@@ -180,6 +183,32 @@ describe Palimpsest::Environment do
       expect(YAML).to receive(:load_file).with("#{environment.directory}/palimpsest_config.yml")
       environment.config
     end
+
+    context "settings given" do
+
+      before :each do
+        allow(YAML).to receive(:load_file).with("#{environment.directory}/palimpsest_config.yml")
+        .and_return( { conf_1: :val_1, conf_2: :val_2 } )
+      end
+
+      it "merges new settings on first call" do
+        expect( environment.config({ conf_3: :val_3 }) ).to eq({ conf_1: :val_1, conf_2: :val_2, conf_3: :val_3 })
+      end
+
+      it "merges new settings on subsequent call" do
+        environment.config
+        expect( environment.config({ conf_3: :val_3 }) ).to eq({ conf_1: :val_1, conf_2: :val_2, conf_3: :val_3 })
+      end
+
+      it "remembers new settings" do
+        environment.config({ conf_3: :val_3 })
+        expect(environment.config).to eq({ conf_1: :val_1, conf_2: :val_2, conf_3: :val_3 })
+      end
+
+      it "overwrites current settings" do
+        expect( environment.config({ conf_2: :new_val_2 }) ).to eq({ conf_1: :val_1, conf_2: :new_val_2 })
+      end
+    end
   end
 
   describe "methods that modify the working directory" do
@@ -196,6 +225,9 @@ describe Palimpsest::Environment do
           :repos:
             - [ my_app, apps/my_app, master ]
             - [ sub_app, apps/my_app/sub_app, my_feature, "https://bitbucket.org/razorx" ]
+        :excludes:
+          - .gitignore
+          - apps/*/assets
         :assets:
           :options:
             :output: compiled
@@ -303,6 +335,22 @@ describe Palimpsest::Environment do
       end
     end
 
+    describe "#remove_excludes" do
+
+      it "removes excluded files" do
+        allow(Dir).to receive(:[]).with("#{environment.directory}/.gitignore")
+        .and_return(["#{environment.directory}/.gitignore"])
+
+        allow(Dir).to receive(:[]).with("#{environment.directory}/apps/*/assets")
+        .and_return( %W(#{environment.directory}/apps/app_1/assets #{environment.directory}/apps/app_2/assets) )
+
+        expect(FileUtils).to receive(:remove_entry_secure).with("#{environment.directory}/.gitignore")
+        expect(FileUtils).to receive(:remove_entry_secure).with("#{environment.directory}/apps/app_1/assets")
+        expect(FileUtils).to receive(:remove_entry_secure).with("#{environment.directory}/apps/app_2/assets")
+        expect(environment.remove_excludes).to be environment
+      end
+    end
+
     describe "#assets" do
 
       subject(:assets) { environment.assets }

data/spec/utility_spec.rb

@@ -13,32 +13,27 @@ describe Palimpsest::Utility do
     end
   end
 
-  describe ".validate_path" do
+  describe ".safe_path?" do
 
     context "valid path" do
 
-      it "returns the input path" do
-        expect(Palimpsest::Utility.validate_path '/path').to eq '/path'
+      it "returns true" do
+        expect(Palimpsest::Utility.safe_path? 'path').to be_true
       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
+    context "invalid path" do
 
-      it "rasises an error if path contains '../'" do
-        expect { Palimpsest::Utility.validate_path 'path/with/../in/it' }.to raise_error RuntimeError
+      it "returns false if path contains '../'" do
+        expect(Palimpsest::Utility.safe_path? 'path/with/../in/it').to be_false
       end
 
-      it "rasises an error if using '~/'" do
-        expect { Palimpsest::Utility.validate_path '~/path' }.to raise_error RuntimeError
+      it "returns false if using '~/'" do
+        expect( Palimpsest::Utility.safe_path? '~/path').to be_false
       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
+      it "returns false if path starts with '/'" do
+        expect(Palimpsest::Utility.safe_path? '/path').to be_false
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: palimpsest
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Evan Boyd Sosenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-28 00:00:00.000000000 Z
+date: 2013-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport