hfam 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8ffbaf7379c27828847ba8cedc0aa708ec97dc4
-  data.tar.gz: c37cb86a42234f1332c31f78bcf035f7eefe23aa
+  metadata.gz: 8f717e2e3ed53363cc3edf32ede40df3e0a36ab0
+  data.tar.gz: df8e9ce5b49b07946d9b486d16accf4697c2a1cc
 SHA512:
-  metadata.gz: 714122a472c5cdcdbfeeb60982e9ee2751b66f08439569b2f1e24240e1199658a6573a8ed2d7d15d42b3bc3dbac370011243ffcfd8e8fa519f5385eabd09debb
-  data.tar.gz: 9d1bd61f378c7040dbdf4680d05514d423a473e70801c386d46d1c8c0fbee16bd8f4691d188c87b29de4c9907da057fdf151fb0caaa9d6c3e082fd3442742511
+  metadata.gz: b3b6d91a15895f9aaf232b7bb0611e85bc236e5b5aa3efc597cd30138ad922cb633283e838f9a559ecc2a8b8567d555879a1a5f5b7d698592d2df5bf47277fb8
+  data.tar.gz: 25768a7db70201cd1952a6872e4d4b2574b32c0b3ff9e0910a3430668bcbe5a2edc17fe47d8bb7cd72f4e3384fa39dcbf5b59a2fb7d38392ba8f20c055e83708

data/README.md

@@ -2,8 +2,8 @@
 
 <b>H</b>idden <b>F</b>iles <b>A</b>re <b>M</b>anageable - Manage, source and reload you dotfiles in a specific directory
 
-1. You create/clone your `dotfiles` directory defined in `$HOME/`. 
-2. You edit a `$HOME/dotfiles/.hfamconfig` with its intuitive DSL.
+1. You create/clone your `dotfiles`. 
+2. You edit a `dotfiles/.hfamconfig` file with its intuitive DSL.
 3. You call `hfam`.
 
 The main advantage of this tool is that you can easily move your `dotfiles` from a machine to another one. Then, with only one command, you can configure your environment.
@@ -45,6 +45,45 @@ Example
      |- .hfamconfig
 ```
 
+####Options
+
+Option `-h --help`
+
+Display the usage:
+
+```shell
+?> hfam --help
+HFAM - Hidden Files Are Manageable
+
+Centralize your dotfiles in one directory and manage them using some basic operations (symlink, source, ...)
+This tool attempts to locate a ~/dotfiles/.hfamconfig file. Then it executes a set of commands
+listed in the config file.
+
+For further information: https://github.com/mehdi-farsi/hfam
+
+USAGE:
+
+hfam [-h|--help] [-p|--path]
+
+OPTIONS:
+
+-h  # help
+-p  # change the default dotfiles path
+```
+
+Option `-p --path`
+
+Change the default dotfiles path.
+
+```shell
+?> hfam --path /Users/zoidberg/Documents/dotfiles
+Symlink: ln -s /Users/mehdi/Documents/dotfiles/testpath /Users/zoidberg/Documents/dotfiles/.testpath
+```
+
+> The path set by --path option is the default symlink target path.
+> use the DSL symlink option `:dest` to override this path.
+
+####Hfamconfig
 
 `hfam` works with a `.hfamconfig` file. This config file provide an intuitive DSL for managing your dotfiles.
 
@@ -57,9 +96,9 @@ For the following examples, let's say that the following environment variables a
 
 Now, let's have look to the `.hfamconfig` DSL.
 
-####Symlink
+#####Symlink
 
-The `symlink` command creates a symlink with the source file passed as argument. The symlink target is defined in `$HOME/.target`.
+The `symlink` command creates a symlink with the source file passed as argument. The symlink target is created in `$HOME/.target`.
 
 Example:
 
@@ -78,7 +117,7 @@ Symlink: ln -s /Users/zoidberg/dotfiles/gitconfig /Users/zoidberg/.gitconfig
 /Users/zoidberg/.gitconfig -> /Users/zoidberg/dotfiles/gitconfig
 ```
 
-The `symlink` command accepts another argument to specify the destination's directory of the symlink. This arguments is named `dest`.
+The `symlink` command accepts another argument to specify the destination's directory. This arguments is named `dest`.
 
 Example:
 
@@ -99,7 +138,7 @@ Symlink: ln -s /Users/mehdi/dotfiles/gitignore /Users/zoidberg/apps/my_app/.giti
 > lrwxr-xr-x  1 lol  cat 27B Nov 11 16:35 .gitconfig -> /Users/zoidberg/dotfiles/gitconfig
 > ```
 
-####Source
+#####Source
 
 The `source` command creates a symlink using the file passed as argument and source the symlink target. The symlink target file is defined at `$HOME/.target`.
 

data/lib/hfam/application.rb

@@ -9,8 +9,8 @@ module HFAM
     end
 
     def run
-      if @payload.metadata.include? :help
-        puts @payload.metadata[:help]
+      if @payload.help_option?
+        puts @payload.help_message
         return
       end
 

data/lib/hfam/argument_parser.rb

@@ -6,12 +6,17 @@ module HFAM
       options = {}
 
       o = ::OptionParser.new do |opts|
+
         opts.banner = ::HFAM::HELP
         
-
-        opts.on("-h") do |h|
+        opts.on("-h", "--help") do |h|
           options[:help] = ::HFAM::HELP
         end
+
+        opts.on("-p=PATH", "--path=PATH") do |p|
+          options[:path] = p
+        end
+
       end
     begin
       o.parse!
@@ -19,6 +24,9 @@ module HFAM
       $stderr.puts e
       $stderr.puts o.banner
       exit
+    rescue ::OptionParser::MissingArgument => e
+      $stderr.puts e
+      exit
     end
       options
     end

data/lib/hfam/constants.rb

@@ -1,7 +1,6 @@
 module HFAM
-  HOME                 = "#{ENV['HOME']}"
-  DEFAULT_DOTFILE_PATH = "#{ENV['HOME']}/dotfiles"
-  HFAMCONFIG_PATH      = "#{DEFAULT_DOTFILE_PATH}/.hfamconfig"
+  HOME                  = "#{ENV['HOME']}"
+  DEFAULT_DOTFILES_PATH = "#{ENV['HOME']}/dotfiles"
 
   HELP = <<-SHELL
 HFAM - Hidden Files Are Manageable
@@ -14,11 +13,11 @@ For further information: https://github.com/mehdi-farsi/hfam
 
 USAGE:
 
-hfam [-h]
+hfam [-h|--help] [-p|--path]
 
 OPTIONS:
 
 -h  # help
-
+-p  # change the default dotfiles path
 SHELL
 end

data/lib/hfam/dsl.rb

@@ -6,16 +6,16 @@ module HFAM
     end
 
     def tokenize
-      raw_commands = eval(::File.open(::HFAM::HFAMCONFIG_PATH).read)
+      raw_commands = eval(::File.open("#{dotfiles_path}/.hfamconfig").read)
     end
 
     def symlink(file, options = {})
-      @payload.commands << [:symlink, "#{DEFAULT_DOTFILE_PATH}/#{file}", dest_path(file, options)]
+      @payload.commands << [:symlink, "#{dotfiles_path}/#{file}", dest_path(options)]
     end
 
     def source(file, options = {})
       symlink(file)
-      @payload.commands << [:source, "#{DEFAULT_DOTFILE_PATH}/#{file}", dest_path(file, options)]
+      @payload.commands << [:source, "#{dotfiles_path}/#{file}", dest_path(options)]
     end
 
     def route
@@ -26,8 +26,15 @@ module HFAM
       @payload.commands << [:unknown, { command: method, args: args }]
     end
 
-    def dest_path(file, options = {})
-      options.include?(:dest) ? options[:dest] : ::HFAM::HOME
+  private
+    def dotfiles_path
+      # File::expand_path convert the builtin "~/" to the path defined in ENV["HOME"]
+      File.expand_path(@payload.metadata[:path] || DEFAULT_DOTFILES_PATH)
+    end
+
+    def dest_path(options = {})
+      # File::expand_path convert the builtin "~/" to the path defined in ENV["HOME"]
+      File.expand_path(options[:dest] || ::HFAM::HOME)
     end
   end
 end

data/lib/hfam/payload.rb

@@ -8,6 +8,14 @@ module HFAM
       self[:commands] = Array.new { |value| [:unknown, value] }
     end
 
+    def help_option?
+      !!metadata[:help]
+    end
+
+    def help_message
+      metadata[:help]
+    end
+
     def metadata
       self[:metadata]
     end

data/lib/hfam/version.rb

@@ -1,3 +1,3 @@
 module HFAM
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hfam
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - mehdi_farsi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-15 00:00:00.000000000 Z
+date: 2015-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -93,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Hidden Files Are Manageable