hfam 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c7927638ebb87bcd2baa0c67a12268473b0ff1f
+  data.tar.gz: ba3b2e762d2544c4e4aa4a6fa8263ee0eed29e8f
+SHA512:
+  metadata.gz: 49204cc66e69d1c0f6e39a64f90ff9c3691d96eabe9a2512625449c1671d0c1c08bdf122f4327d682504d7efd8808fe88f277715520f7294860db80ccabb82fe
+  data.tar.gz: 9dd55b586d1e960bf0da63329b25e66fccc2d012066c66bd3023b55cac9734666ec21bf5c7571da375772abe6369f7117d8a82530055bc9dd099572367dcfdc4

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hfam.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    hfam (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  hfam!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.10.6

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Mehdi FARSI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,130 @@
+# HFAM
+
+<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.
+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.
+
+###Prerequisites
+
+you need to install `ruby`:
+
+```shell
+?> \curl -sSL https://get.rvm.io | bash -s stable
+?> rvm install ruby-head
+```
+
+Check if `ruby` is installed:
+
+```shell
+?> ruby --version
+```
+
+###Install
+
+```shell
+?> gem install hfam
+```
+
+I recommend you to put all your `dotfiles` in a Git repository named `dotfiles`.
+
+clone your repo and add a file named `.hfamconfig`.
+
+###Usage
+
+Example
+
+```asciidoc
+~/
+  |- dotfiles/
+     |- gitconfig
+     |- zshrc
+     |- .hfamconfig
+```
+
+
+`hfam` works with a `.hfamconfig` file. This config file provide an intuitive DSL for managing your dotfiles.
+
+> Only the files defined in `.hfamconfig` will be treated.
+
+For the following examples, let's say that the following environment variables are set with the following values:
+
+- `HOME=/Users/zoidberg`
+- `SHELL=/bin/zsh`
+
+Now, let's have look to the `.hfamconfig` DSL.
+
+####Symlink
+
+The `symlink` command creates a symlink with the source file passed as argument. The symlink target is defined in `$HOME/.target`.
+
+Example:
+
+In `$HOME/dotfiles/.hfamconfig`
+
+```ruby
+symlink "gitconfig" # you can add a comment using '#'
+```
+
+And then
+
+```shell
+?> hfam
+Symlink: ln -s /Users/zoidberg/dotfiles/gitconfig /Users/zoidberg/.gitconfig
+?> ls -l $HOME/.gitconfig
+/Users/zoidberg/.gitconfig -> /Users/zoidberg/dotfiles/gitconfig
+```
+
+
+> /!\ If the source file is not a dotfile, the prefix `.` is automatically prepended to the target file
+> ```shell
+> ?> ls -l $HOME/.gitconfig
+> lrwxr-xr-x  1 lol  cat 27B Nov 11 16:35 .gitconfig -> /Users/zoidberg/dotfiles/gitconfig
+> ```
+
+####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`.
+
+Example:
+
+In `$HOME/dotfiles/.hfamconfig`
+
+```ruby
+source "zshrc"
+```
+
+And then
+
+```shell
+?> hfam
+Symlink: ln -s /Users/zoidberg/dotfiles/zshrc /Users/zoidberg/.zshrc
+Source: /bin/zsh -c 'source /Users/zoidberg/.zshrc'
+?>
+```
+
+
+> /!\ The SHELL env variable is used to defined the current shell.
+>     If the default shell is `dash`, then it uses the '.' command to source the file.
+>     Else, it uses the `source` command.
+>     If the SHELL is a symlink to another shell, then it reach the real shell targeted by the symlink:
+>     [for further information](https://wiki.ubuntu.com/DashAsBinSh#My_production_system_has_broken_and_I_just_want_to_get_it_back_up.21)
+
+## Development
+
+After checking out the repo, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mehdi-farsi/activerecord-search.
+
+We have a lot of idea that we put in the issue list. Feel free to have a look to it.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+> Please, feel free to star the project if you like it ! :)

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/hfam

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+# PATH_TO_GEMSET/hfam-VERSION/lib
+hfam_dir = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+# add hfam_dir to LOAD_PATH
+$LOAD_PATH.unshift(hfam_dir) unless $LOAD_PATH.include?(hfam_dir)
+
+require "hfam"
+
+HFAM::Application.new.run

data/hfam.gemspec

@@ -0,0 +1,45 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hfam'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hfam"
+  spec.version       = HFAM::VERSION
+  spec.authors       = ["mehdi_farsi"]
+  spec.date          = Time.now.strftime("%F")
+  spec.email         = ["mehdifarsi.pro@gmail.com"]
+
+  spec.summary       = %q{Hidden Files Are Manageable}
+  spec.description   = %q{Manage and reload you dotfiles in a centralized directory}
+  spec.homepage      = "https://github.com/mehdi-farsi/hfam"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  
+  spec.require_paths = ["lib"]
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  
+
+  spec.required_ruby_version = '>= 1.9.3'
+  spec.post_install_message = <<-EOF
+  Thanks for installing!
+  
+  You can follow me on:
+    - Twitter: @farsi_mehdi
+    - Github: mehdi-farsi
+  
+  This project permits to help to solve a common problem. My reward is to see you using it.
+  
+  So please, feel free to 'star' the project on GitHub:
+  
+  https://github.com/mehdi-farsi/activerecord-search
+  
+   Many Thanks !
+  EOF
+
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/core_ext/fileutils.rb

@@ -0,0 +1,5 @@
+module FileUtils
+  def self.hidden_file?(path_to_file)
+    path_to_file[0] == '.'
+  end
+end

data/lib/core_ext/string.rb

@@ -0,0 +1,26 @@
+class String
+  def black;          "\e[30m#{self}\e[0m" end
+  def red;            "\e[31m#{self}\e[0m" end
+  def green;          "\e[32m#{self}\e[0m" end
+  def brown;          "\e[33m#{self}\e[0m" end
+  def orange;         "\e[1;33m#{self}\e[0m" end
+  def blue;           "\e[34m#{self}\e[0m" end
+  def magenta;        "\e[35m#{self}\e[0m" end
+  def cyan;           "\e[36m#{self}\e[0m" end
+  def gray;           "\e[37m#{self}\e[0m" end
+
+  def bg_black;       "\e[40m#{self}\e[0m" end
+  def bg_red;         "\e[41m#{self}\e[0m" end
+  def bg_green;       "\e[42m#{self}\e[0m" end
+  def bg_brown;       "\e[43m#{self}\e[0m" end
+  def bg_blue;        "\e[44m#{self}\e[0m" end
+  def bg_magenta;     "\e[45m#{self}\e[0m" end
+  def bg_cyan;        "\e[46m#{self}\e[0m" end
+  def bg_gray;        "\e[47m#{self}\e[0m" end
+
+  def bold;           "\e[1m#{self}\e[22m" end
+  def italic;         "\e[3m#{self}\e[23m" end
+  def underline;      "\e[4m#{self}\e[24m" end
+  def blink;          "\e[5m#{self}\e[25m" end
+  def reverse_color;  "\e[7m#{self}\e[27m" end
+end

data/lib/hfam.rb

@@ -0,0 +1,15 @@
+require "hfam/application.rb"
+require "hfam/argument_parser.rb"
+require "hfam/command.rb"
+require "hfam/command/base.rb"
+require "hfam/commands/symlink.rb"
+require "hfam/commands/source.rb"
+require "hfam/command_set.rb"
+require "hfam/constants.rb"
+require "hfam/dsl.rb"
+require "hfam/logger.rb"
+require "hfam/payload.rb"
+require "hfam/version"
+
+require "core_ext/fileutils.rb"
+require "core_ext/string.rb"

data/lib/hfam/application.rb

@@ -0,0 +1,22 @@
+module HFAM
+  class Application
+    def initialize
+      @payload = ::HFAM::Payload.new
+
+      @payload.metadata = ArgumentParser.new.parse
+
+      @command_set = CommandSet.new
+    end
+
+    def run
+      if @payload.metadata.include? :help
+        puts @payload.metadata[:help]
+        return
+      end
+
+      dsl = ::HFAM::DSL.new(@payload).tokenize
+
+      @command_set.dispatch_commands(@payload)
+    end
+  end
+end

data/lib/hfam/argument_parser.rb

@@ -0,0 +1,26 @@
+require "optparse"
+
+module HFAM
+  class ArgumentParser
+    def parse
+      options = {}
+
+      o = ::OptionParser.new do |opts|
+        opts.banner = ::HFAM::HELP
+        
+
+        opts.on("-h") do |h|
+          options[:help] = ::HFAM::HELP
+        end
+      end
+    begin
+      o.parse!
+    rescue ::OptionParser::InvalidOption => e
+      $stderr.puts e
+      $stderr.puts o.banner
+      exit
+    end
+      options
+    end
+  end
+end

data/lib/hfam/command.rb

@@ -0,0 +1,2 @@
+Dir.glob("./lib/hfam/command/*").each  { |command| require command }
+Dir.glob("./lib/hfam/commands/*").each { |command| require command }

data/lib/hfam/command/base.rb

@@ -0,0 +1,6 @@
+module HFAM
+  module Command
+    class Base
+    end
+  end
+end

data/lib/hfam/command_set.rb

@@ -0,0 +1,19 @@
+module HFAM
+  class CommandSet
+    def initialize
+      @commands = {
+        symlink: ::HFAM::Command::Symlink.new,
+        source:  ::HFAM::Command::Source.new
+      }
+    end
+
+    def dispatch_commands(payload)
+      payload.commands.each_with_index do |command, index|
+        ::HFAM::Logger.error("hfamconfig:#{index + 1} : unknown command '#{command[1][:command]}' with args #{command[1][:args]}") and next if command[0] == :unknown
+        
+        @commands[command[0]].run(command)
+      end
+    end
+
+  end
+end

data/lib/hfam/commands/source.rb

@@ -0,0 +1,37 @@
+require "fileutils"
+require "pathname"
+
+module HFAM
+  module Command
+    class Source < Base
+
+      def run(command)
+        src  = command[1]
+
+        ::HFAM::Logger.error("No such file or directory: #{src}") and return unless File.exist? src
+
+        # preprend the dest file with a '.' if the src file is not a hidden file 
+        file = src.split('/').last
+        file = ::FileUtils.hidden_file?(file) ? file : ".#{file}"
+        dest = command[2] || "#{::HFAM::HOME}/#{file}"
+
+        # https://wiki.ubuntu.com/DashAsBinSh#My_production_system_has_broken_and_I_just_want_to_get_it_back_up.21
+        # Sometime the default shell /bin/sh is a symlink to another shell
+        # Pathname#realpath permits to reach the target of a symlink 
+        real_shell_path = ::Pathname.new(ENV['SHELL']).realpath.to_s
+
+        # /bin/dash doesn't implement the builtin 'source'. Instead, it uses the '.' command
+        cmd = real_shell_path.split('/').last == "dash" ? '.' : "source"
+
+        (cmd = "#{real_shell_path} -c '#{cmd} #{dest}'") && result = `#{cmd}`
+
+        ::HFAM::Logger.success("Source: Command result: #{result}")
+        ::HFAM::Logger.success("Source: #{cmd}")
+
+      rescue ::Errno::EACCES => e
+        l::HFAM::Logger.error("Unable to source #{dest} (Permission Denied)")
+      end
+
+    end
+  end
+end

data/lib/hfam/commands/symlink.rb

@@ -0,0 +1,28 @@
+require "fileutils"
+
+module HFAM
+  module Command
+    class Symlink < Base
+
+      def run(command)
+        src  = command[1]
+
+        ::HFAM::Logger.error("No such file or directory: #{src}") and return unless File.exist? src
+
+        # preprend the dest file with a '.' if the src file is not a hidden file 
+        file = src.split('/').last
+        file = ::FileUtils.hidden_file?(file) ? file : ".#{file}"
+        dest = command[2] || "#{::HFAM::HOME}/#{file}"
+
+        # ln -s with --force option
+        ::FileUtils.ln_sf(src, dest)
+
+        ::HFAM::Logger.success("Symlink: ln -s #{src} #{dest}")
+
+      rescue ::Errno::EACCES => e
+        l::HFAM::Logger.error("Unable to generate symlink #{src} #{dest} (Permission Denied)")
+      end
+
+    end
+  end
+end

data/lib/hfam/constants.rb

@@ -0,0 +1,24 @@
+module HFAM
+  HOME                 = "#{ENV['HOME']}"
+  DEFAULT_DOTFILE_PATH = "#{ENV['HOME']}/dotfiles"
+  HFAMCONFIG_PATH      = "#{DEFAULT_DOTFILE_PATH}/.hfamconfig"
+
+  HELP = <<-SHELL
+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]
+
+OPTIONS:
+
+-h  # help
+
+SHELL
+end

data/lib/hfam/dsl.rb

@@ -0,0 +1,29 @@
+module HFAM
+  # Should respond to method :tokenize and :route
+  class DSL
+    def initialize(payload)
+      @payload = payload
+    end
+
+    def tokenize
+      raw_commands = eval(::File.open(::HFAM::HFAMCONFIG_PATH).read)
+    end
+
+    def symlink(file)
+      @payload.commands << [:symlink, "#{DEFAULT_DOTFILE_PATH}/#{file}"]
+    end
+
+    def source(file)
+      symlink(file)
+      @payload.commands << [:source, "#{DEFAULT_DOTFILE_PATH}/#{file}"]
+    end
+
+    def route
+      @command_set.run_command
+    end
+
+    def method_missing(method, *args, &block)
+      @payload.commands << [:unknown, { command: method, args: args }]
+    end
+  end
+end

data/lib/hfam/logger.rb

@@ -0,0 +1,20 @@
+module HFAM
+  module Logger
+    class << self
+      def success(message)
+        puts message.green
+        true
+      end
+
+      def warn(message)
+        puts message.orange
+        true
+      end
+
+      def error(message)
+        $stderr.puts message.red
+        true
+      end
+    end
+  end
+end

data/lib/hfam/payload.rb

@@ -0,0 +1,24 @@
+module HFAM
+  class Payload < Hash
+    
+    def initialize
+      super
+
+      self[:metadata] = Hash.new
+      self[:commands] = Array.new { |value| [:unknown, value] }
+    end
+
+    def metadata
+      self[:metadata]
+    end
+
+    def metadata=(h)
+      self[:metadata] = h.dup
+    end
+
+    def commands
+      self[:commands]
+    end
+
+  end
+end

data/lib/hfam/version.rb

@@ -0,0 +1,3 @@
+module HFAM
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: hfam
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- mehdi_farsi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Manage and reload you dotfiles in a centralized directory
+email:
+- mehdifarsi.pro@gmail.com
+executables:
+- hfam
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/hfam
+- hfam.gemspec
+- lib/core_ext/fileutils.rb
+- lib/core_ext/string.rb
+- lib/hfam.rb
+- lib/hfam/application.rb
+- lib/hfam/argument_parser.rb
+- lib/hfam/command.rb
+- lib/hfam/command/base.rb
+- lib/hfam/command_set.rb
+- lib/hfam/commands/source.rb
+- lib/hfam/commands/symlink.rb
+- lib/hfam/constants.rb
+- lib/hfam/dsl.rb
+- lib/hfam/logger.rb
+- lib/hfam/payload.rb
+- lib/hfam/version.rb
+homepage: https://github.com/mehdi-farsi/hfam
+licenses:
+- MIT
+metadata: {}
+post_install_message: "  Thanks for installing!\n  \n  You can follow me on:\n    -
+  Twitter: @farsi_mehdi\n    - Github: mehdi-farsi\n  \n  This project permits to
+  help to solve a common problem. My reward is to see you using it.\n  \n  So please,
+  feel free to 'star' the project on GitHub:\n  \n  https://github.com/mehdi-farsi/activerecord-search\n
+  \ \n   Many Thanks !\n"
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Hidden Files Are Manageable
+test_files: []