peridot 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 965e2a6b1fe6c30be1856eb4c8525175844444b7
-  data.tar.gz: e740a77f8f4c965f43d7640804370d4bd72bf42a
+  metadata.gz: 9ebbd954622582f64a6dd7b398a24ff587fdf28c
+  data.tar.gz: a47a5794a6bce94b41ed0f7e5e4f3eec01b7d846
 SHA512:
-  metadata.gz: ac7bb43c4b127dee95eb01fb394c11fb067ac2e0f92053a81d3a46bf51740d282f6a79ba8e32818da7b1c78f9bf916bc912135d9e3731692f00b79b7f979eb50
-  data.tar.gz: e6a6181016bea59ca4b71c9526f79de6b49e3fa999736cfb2642ad60158b5dbbd3d8ea6c1d2cfc7850a33d334b445a9374153fc5a746a6998fd25fed5beb1b20
+  metadata.gz: 35aff1a9f6ed05dcf18a97a22ebdc022ce6e7db7544cbe5ea59b02ce2398363f4bffc7c5b2e15c36d7d3eed1cbdaca3bb57ec1f7f093eeff2189754e4005caad
+  data.tar.gz: fa9b32224f140e22c22bdc966995baf3789ea11b398e055443b2f3d1291345229828511d87463b99afcf87eff89dbe4c1b6704704f15a071cba4ce07789f8026

data/README.md

@@ -1,5 +1,7 @@
 # Peridot
 
+[![Gem Version](https://badge.fury.io/rb/peridot.png)](http://badge.fury.io/rb/peridot)
+
 Peridot let's you manage your dotfiles with `rake` and you should love `rake`!
 Seriously!
 
@@ -7,43 +9,41 @@ Seriously!
 
 Install it yourself via:
 
-    $ gem install peridot
+```bash
+$ gem install peridot
+```
 
 ## Usage
 
 In your Rakefile require Peridot. If run inside rake, it will automagically
 include Peridot module:
 
-    require 'peridot'
+```ruby
+require 'peridot'
+```
 
 After this, copy the following to a fresh Rakefile:
 
-    require 'rubygems'
-    require 'peridot'
+```ruby
+require 'rubygems'
+require 'peridot'
+```
 
 After this Peridot provides you with 2 standard tasks:
 
-    $ rake -T
-    rake dotfiles  # Runs all your task in the dotfiles namespace
-    rake watch     # Watches for changes and reruns rake
+```bash
+$ rake -T
+rake dotfiles  # Runs all your task in the dotfiles namespace
+rake watch     # Watches for changes and reruns rake
+```
 
 Peridot runs every task under `dotfiles` namespace if you run the `dotfiles`
 task.
 
-If you need to set up some environment for your dotfiles
-(e.g. different values for git email at home/work) you do this with tasks for
-each environment as Peridot relies heavily on `rake`.
-
-    task(:work) { set :git_email, 'work@startup.com' }
-    task(:home) { set :git_email, 'home@hotel-mama.com' }
-
-You can than use it in an erb file like this:
-
-    email = <%= get! :git_email %>
 
 ## Features
 
-Peridot gives you some nice methods for interacting with your dotfiles.
+Peridot gives you some methods for interacting with your dotfiles.
 
 ### Path helpers
 
@@ -54,40 +54,57 @@ files.
 
 There is a convenience method to generate a regular files from erb input.
 
-    generate_file(from, to)
+```ruby
+generate_file repo_file('gitconfig.erb'), home_file('.gitconfig')
+```
 
 ### Watch for changes
 
 You can add a special task `watch` to your rake command to have Peridot
 watch for changes and rerun your rake command.
 
-### Attributes
-
-There is `#set` to aid you in setting options for later use in
-your rake tasks. On the other side there is `#get` which fetches attributes
-from a central storage. To raise an exception if a required attribute is
-missing there is also `#get!`.
-
 ### Ignoring files
 
 With `#ignored_files` there is a standard list of files and filetypes
-which can be matched (regexp) again certain files with `#ignored?(file)`
+which can be matched (regexp) again certain files with `#ignored?(file)`.
 
-    ignored_files << 'README'
-    link_file from, to unless ignored?('README')
+```ruby
+ignored_files << 'README'
+link_file(from, to) unless ignored?('README')
+```
 
 ### FileUtils
 
 All methods from `FileUtils` are included in the global namespace and can be
 used for mastering your dotfiles.
 
+### Configuration
+
+If you need to have some configuration in place you are free to use environment
+variables. [Dotenv](https://github.com/bkeepers/dotenv) can also be used by
+making it a dependency of your task.
+
+```ruby
+require 'dotenv/tasks'
+
+task :zsh => :dotenv do …
+```
+
+You can even raise an exception if a required configuration file is missing.
+
+```ruby
+require 'dotenv'
+Dotenv.load! '~/.env'
+```
+
 ## Examples in the wild
 
-Take look at my dotfiles: https://github.com/svenwin/dotfiles/blob/master/Rakefile
+* Take look at my [dotfiles](https://github.com/svenwin/dotfiles/blob/master/Rakefile)
+* [@danielbayerlein](https://github.com/danielbayerlein/dotfiles/blob/master/Rakefile)
 
 ## Special Thanks
 
-* [Daniel Bayerlein(@danielbayerlein)](https://github.com/danielbayerlein) -
+* [Daniel Bayerlein (@danielbayerlein)](https://github.com/danielbayerlein) -
 For support, code review and much more
 * [Jim Weirich (@jimweirich)](https://github.com/jimweirich) - for creating
 [Rake](https://github.com/jimweirich/rake)

data/Rakefile

@@ -1,2 +1,2 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'

data/lib/peridot/file_access.rb

@@ -1,39 +1,27 @@
 require 'fileutils'
 
-module Peridot::FileAccess
-  include(::FileUtils)
-
-  def ignored_files
-    @ignored_files ||= %w(Rakefile \.erb$)
-  end
-
-  def ignored_files=(files)
-    @ignored_files = files
-  end
-
-  def ignored?(file)
-    ignored_files.any? { |ignore_file| file.match(ignore_file) }
-  end
-
-  def generate_file(source, target)
-    puts("Generating #{target}")
-    template = ERB.new(File.read(source))
-    template.filename = target
-    File.open(target, 'w') do |f|
-      f.write(template.result(binding))
+module Peridot
+  module FileAccess
+    include ::FileUtils
+
+    def generate_file source, target
+      puts "Generating #{target}"
+      template = ERB.new File.read source
+      template.filename = target
+      File.open(target, 'w') { |f| f.write template.result(binding) }
     end
-  end
 
-  def home_file(file)
-    File.join(Dir.home, file)
-  end
+    def home_file file
+      File.join Dir.home, file
+    end
 
-  def repo_file(file)
-    File.join(Dir.pwd, file)
-  end
+    def repo_file file
+      File.join Dir.pwd, file
+    end
 
-  def link_file(source, target)
-    rm_f(target)
-    ln_s(source, target)
+    def link_file source, target
+      rm_f target
+      ln_s source, target
+    end
   end
 end

data/lib/peridot/ignores.rb

@@ -1,13 +1,15 @@
-module Peridot::Ignores
-  def ignored_files
-    @ignored_files ||= %w(Rakefile \.erb$)
-  end
+module Peridot
+  module Ignores
+    def ignored_files
+      @ignored_files ||= %w(Rakefile README.*$ \.erb$)
+    end
 
-  def ignored_files=(files)
-    @ignored_files = files
-  end
+    def ignored_files=(files)
+      @ignored_files = files
+    end
 
-  def ignored?(file)
-    ignored_files.any? { |ignore_file| file.match(ignore_file) }
+    def ignored?(file)
+      ignored_files.any? { |ignore_expr| file.match ignore_expr }
+    end
   end
 end

data/lib/peridot/version.rb

@@ -1,3 +1,3 @@
 module Peridot
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/lib/peridot.rb

@@ -1,22 +1,14 @@
 require 'erb'
-require 'peridot/attribute_storage'
 require 'peridot/file_access'
-require 'peridot/forwardable'
 require 'peridot/ignores'
 require 'peridot/version'
 require 'peridot/watcher'
 
 module Peridot
   def self.included(base)
-    [FileAccess, Forwardable].each { |klass| base.send(:include, klass) }
-
-    base.forward(:get, :get!, :set, to: :attributes)
-
-    load('peridot/tasks.rake') if defined?(Rake)
-  end
-
-  def attributes
-    @attributes ||= AttributeStorage.new
+    base.send :include, FileAccess
+    base.send :include, Ignores
+    load 'peridot/tasks.rake'
   end
 end
 

data/peridot.gemspec

@@ -8,10 +8,12 @@ Gem::Specification.new do |gem|
   gem.summary       = %q{Dotfile management with rake on steroids}
 
   gem.files         = `git ls-files`.split($\)
+  gem.homepage      = 'https://github.com/svenwin/peridot'
   gem.name          = 'peridot'
   gem.require_paths = %w(lib)
   gem.version       = Peridot::VERSION
 
-  gem.add_dependency('rake')
-  gem.add_dependency('listen')
+  gem.add_dependency('dotenv', '0.9.0')
+  gem.add_dependency('listen', '1.3.1')
+  gem.add_dependency('rake', '10.1.0')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: peridot
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Sven
@@ -9,36 +9,50 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-18 00:00:00.000000000 Z
+date: 2013-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: dotenv
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: listen
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.1.0
 description: Dotfile management with rake on steroids
 email:
 - sven@w5r.org
@@ -52,15 +66,13 @@ files:
 - README.md
 - Rakefile
 - lib/peridot.rb
-- lib/peridot/attribute_storage.rb
 - lib/peridot/file_access.rb
-- lib/peridot/forwardable.rb
 - lib/peridot/ignores.rb
 - lib/peridot/tasks.rake
 - lib/peridot/version.rb
 - lib/peridot/watcher.rb
 - peridot.gemspec
-homepage: 
+homepage: https://github.com/svenwin/peridot
 licenses: []
 metadata: {}
 post_install_message: 

data/lib/peridot/attribute_storage.rb

@@ -1,19 +0,0 @@
-module Peridot
-  class AttributeStorage
-    def initialize(hash = {})
-      @hash = hash
-    end
-
-    def get(key)
-      @hash.fetch(key)
-    end
-
-    def get!(key)
-      get(key) or raise("#{key} is not an attribute")
-    end
-
-    def set(key, value)
-      @hash.store(key, value)
-    end
-  end
-end

data/lib/peridot/forwardable.rb

@@ -1,9 +0,0 @@
-module Peridot::Forwardable
-  def forward(*methods, target_hash)
-    methods.each do |m|
-      define_method m do |*args|
-        send(target_hash[:to]).send(m, *args)
-      end
-    end
-  end
-end