dir_friend 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c521ee35292eca17bf8f359334ff82317ff9c1c6
-  data.tar.gz: 47802dbb3d9f0bd4196e3548bbc9de2003f4d883
+  metadata.gz: 686edf0244b614d5c5ed36dd54cc5e156a4bfdfc
+  data.tar.gz: cd4f54a0c1d265a811d657ea8ec9ebd92e2cf562
 SHA512:
-  metadata.gz: 271eab6489bfbfc6dc8bd3f01ee10fbcf86d8480c32bd9e0493a8c7d4763ad9ba47968ecd0db64f7a318d6c13ec3c8580bdf5ff9524bca163f47f9deffb6665e
-  data.tar.gz: 82d14d0bef8ca232e4130f50d39831750d96d61e559342b692289c53c87c648bc8a6a927940c13c3fcbc3043d94b38104e7c871c3c1fea6c7ac868370962ba7a
+  metadata.gz: 55d033751543bd9db638f3c680a7845b07af5481f7a3b18881742150129ec61db7bbe8e34cdbfac3551f7c012180bee47c6132ed7b92b66270082c4f038825c7
+  data.tar.gz: b447ba2ff5418c2d04933841b73697c4c9960eb8f518b8237e7d18db18806619bd48bd13d6e201a9743224a13dcf915f93acda11a27b1748dcadcb5ed7a8cc66

data/README.md

@@ -1,6 +1,6 @@
 # DirFriend
 
-`DirFriend` is a tool for visualizing file directory.
+`DirFriend` is a tool for generating a DOT file which represent file directories.
 
 ## Installation
 
@@ -26,10 +26,15 @@ In your terminal, try followings;
     # Create a dot file for path/to/project
     % dir_friend dot path/to/project
     
-    # Create with some options
+    # Create it with some options
     % dir_friend dot path/to/project -l fdp -c blues --dir_shape box
     % dir_friend dot path/to/project -g "bgcolor:azure,rkdir:LR,splines:ortho"
 
+`dot` subcommand first creates `config.yaml` in 'YOUR_HOME_DIR/.dirfriend', which contains some pre-defined theme settings. You can call any of the themes with '--theme (or -t)' option for `dot` subcommand.
+
+    % dir_friend dot path/to/project --theme blueegg
+
+
 In your ruby script;
 
 ```ruby

data/lib/dir_friend.rb

@@ -1,11 +1,14 @@
 require 'gviz'
 require 'tempfile'
+require 'fileutils'
 
-require "dir_friend/version"
-require "dir_friend/f"
-require "dir_friend/d"
-require "dir_friend/any"
-require "dir_friend/graph"
+require 'dir_friend/version'
+require 'dir_friend/core_ext'
+require 'dir_friend/f'
+require 'dir_friend/d'
+require 'dir_friend/any'
+require 'dir_friend/graph'
+require 'dir_friend/config'
 require 'dir_friend/command'
 
 module DirFriend

data/lib/dir_friend/command.rb

@@ -1,4 +1,5 @@
 require 'thor'
+require 'yaml'
 
 module DirFriend
   class Command < Thor
@@ -10,12 +11,12 @@ module DirFriend
     end
 
     desc "dot PATH", "Create a graphviz dot file for PATH"
-    long_desc <<-EOS
-ex.
+    long_desc ~<<-EOS
+      ex.
 
-  `dir_friend dot path/ -l fdp -c blues, -e "arrowhead:none"`
+        `dir_friend dot path/ -l fdp -c blues, -e "arrowhead:none"`
 
-  `dir_friend dot path/ -c greens -g "bgcolor:azure,rankdir:LR,splines:ortho"`
+        `dir_friend dot path/ -c greens -g "bgcolor:azure,rankdir:LR,splines:ortho"`
     EOS
     option :layout, aliases:"-l"
     option :colorscheme, aliases:"-c"
@@ -27,13 +28,15 @@ ex.
     option :save, aliases:"-s", default:'a'
     option :depth, aliases:"-d", default:9
     option :with_open, aliases:"-o", default: true, type: :boolean
+    option :theme, aliases:"-t"
     def dot(path)
-      opt = options.dup.inject({}) { |h, (k,v)| h[k.intern] = v; h  }
+      opt = options.to_keysym_hash
       save_path = opt.delete(:save)
       opt = opt_parser(opt)
+
       dir = D.new(path, depth:options[:depth].to_i)
       dir.to_dot(opt).save(save_path)
-      puts "Dot file created: `#{save_path}.dot`"
+      puts "'#{save_path}.dot' created in the current directory."
 
       if options[:with_open] && OS.mac?
         run(%Q{open "#{save_path}.dot"}, verbose: false)
@@ -67,7 +70,12 @@ DirFriend is a tool for visualizing file directory.
             opt.update({attr => Hash[ kv_arr ]})
           end
         end
-        opt
+        if Config.enable
+          theme = Config.read(opt.delete(:theme))
+          theme.merge(opt)
+        else
+          opt
+        end
       end
     end
   end

data/lib/dir_friend/config.rb

@@ -0,0 +1,63 @@
+
+module DirFriend
+  class Config
+    CONFIG_PATH = File.join(ENV['HOME'], '.dirfriend/config.yaml')
+    CONFIG_FILE = File.basename(CONFIG_PATH)
+    class << self
+      def read(theme)
+        new.read(theme)
+      end
+      attr_accessor :enable
+    end
+    self.enable = true
+
+    def read(theme)
+      if theme
+        use_passed_theme(theme)
+      else
+        use_default_theme
+      end
+    end
+
+    def themes
+      @themes ||= YAML.load_file(CONFIG_PATH).to_keysym_hash
+    rescue Errno::ENOENT
+      create
+      {}
+    rescue Psych::SyntaxError => e
+      abort "Syntax errors found in your '#{CONFIG_FILE}': #{e}."
+    end
+
+    private
+    def create
+      dir = File.dirname(CONFIG_PATH)
+      Dir.mkdir(dir) unless Dir.exist?(dir)
+      FileUtils.copy(template, CONFIG_PATH)
+      puts "'#{CONFIG_FILE}' created in #{dir}."
+      puts "You can set a theme for dot from pre-defined or created by you!"
+    rescue => e
+      abort "Something go wrong: #{e}."
+    end
+
+    def template
+      File.join(__dir__, 'template.yaml')
+    end
+
+    def use_passed_theme(theme)
+      themes[theme.intern].tap do |tm|
+        abort "Theme: '#{theme}' not found in your #{CONFIG_FILE}." unless tm
+      end
+    end
+
+    def use_default_theme
+      case defo = themes.delete(:default)
+      when Symbol, String
+        themes[defo.intern] || {}
+      when Hash
+        defo
+      else
+        {}
+      end
+    end
+  end
+end

data/lib/dir_friend/core_ext.rb

@@ -0,0 +1,23 @@
+module HashExtension
+  def to_keysym_hash
+    self.inject({}) do |h, (k, v)|
+      h[k.intern] = begin
+        case v
+        when Hash then v.to_keysym_hash
+        else v
+        end
+      end
+      h
+    end
+  end
+end
+
+module StringExtension
+  def ~
+    margin = scan(/^ +/).map(&:size).min
+    gsub(/^ {#{margin}}/, '')
+  end
+end
+
+Hash.send(:include, HashExtension)
+String.send(:include, StringExtension)

data/lib/dir_friend/template.yaml

@@ -0,0 +1,68 @@
+# This is a template for `dir_friend dot` subcommand.
+# 
+# You can set a theme to default by giving
+# one of the theme names or a hash settings directly
+#
+# ex.
+#   default: :pop
+#
+#   default:
+#     colorscheme: reds
+#     style: fdp
+#
+# Themes can be called with '--theme' or '-t' option of `dot` subcommand.
+#
+# ex. `dir_friend dot path/ -t pop
+
+default: tree
+
+tree:
+  global:
+    rankdir: LR
+    splines: ortho
+  dir_shape: diamond
+
+blueegg:
+  colorscheme: blues
+  edges:
+    color: lightblue
+  nodes:
+    shape: egg
+
+inline:
+  layout: osage
+  colorscheme: greens
+  nodes:
+    shape: box
+  edges:
+    color: gold
+
+closeup:
+  layout: neato
+  colorscheme: purd
+  nodes:
+    shape: polygon
+
+flower:
+  layout: circo
+  colorscheme: rdylgn
+  nodes:
+    shape: doublecircle
+
+rigid:
+  layout: sfdp
+  colorscheme: greys
+  nodes:
+    shape: doubleoctagon
+
+star:
+  layout: dot
+  colorscheme: set310
+  global:
+    bgcolor: midnightblue
+    splines: curved
+  edges:
+    color: snow
+    arrowhead: none
+  nodes:
+    shape: star

data/lib/dir_friend/version.rb

@@ -1,3 +1,3 @@
 module DirFriend
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

data/spec/command_spec.rb

@@ -20,6 +20,7 @@ describe DirFriend::Command do
   describe '#dot' do
     before(:each) do
       %w(A A/D A/D/G).each { |d| Dir.mkdir d }
+      DirFriend::Config.enable = false
     end
 
     around do |example|
@@ -37,7 +38,7 @@ describe DirFriend::Command do
             with('open "a.dot"', verbose: false)
 
           stdout = capture(:stdout) { described_class.start(['dot', 'A']) }
-          expect(stdout).to include 'Dot file created:'
+          expect(stdout).to include 'created in the current directory'
         end
 
         it 'should parse option' do
@@ -48,7 +49,7 @@ describe DirFriend::Command do
           stdout = capture(:stdout) {
             described_class.start(['dot', '--with-open=false', 'A'])
           }
-          expect(stdout).to include 'Dot file created:'
+          expect(stdout).to include 'created in the current directory'
         end
       end if DirFriend::OS.mac?
 
@@ -65,7 +66,7 @@ describe DirFriend::Command do
           stdout = capture(:stdout) {
             described_class.start(['dot', '--with-open', 'A'])
           }
-          expect(stdout).to include 'Dot file created:'
+          expect(stdout).to include 'created in the current directory'
         end
       end
     end

data/spec/config_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+require 'fakefs/spec_helpers'
+
+
+describe DirFriend::Config do
+  include FakeFS::SpecHelpers
+
+  before(:each) do
+    stub_const("DirFriend::Config::CONFIG_PATH", "config.yaml")
+    File.write(described_class::CONFIG_PATH, ~<<-EOS)
+      default: :theme1
+      theme1:
+        colorscheme: reds
+        layout: fdp
+      theme2:
+        colorscheme: blues
+        layout: dot
+    EOS
+    File.write('template.yaml', '')
+  end
+
+  describe '#themes' do
+    context 'config file exist' do
+      it 'read user settings' do
+        themes = described_class.new.themes
+        expected = { default: :theme1,
+                     theme1:{colorscheme:'reds', layout:'fdp'},
+                     theme2:{colorscheme:'blues', layout:'dot'} }
+        expect(themes).to eq expected
+      end
+    end
+
+    context 'config file not exist' do
+      it 'creates a config file and returns a empty hash' do
+        config = described_class.new
+        config.instance_variable_set("@themes", nil)
+        stub_const("DirFriend::Config::CONFIG_PATH", "wrong_name_config.yaml")
+        config.stub(:template).and_return('template.yaml')
+        themes = config.themes
+        expect(themes).to be_empty
+      end
+    end
+  end
+
+  describe '#read' do
+    context 'with nil argument' do
+      it 'returns default theme' do
+        theme = described_class.read(nil)
+        expected = {colorscheme:'reds', layout:'fdp'}
+        expect(theme).to eq expected
+      end
+    end
+
+    context 'with a theme argument' do
+      it 'returns the theme' do
+        theme = described_class.read(:theme2)
+        expected = {colorscheme:'blues', layout:'dot'}
+        expect(theme).to eq expected
+      end
+    end
+
+    context 'when the default value is a hash data' do
+      before(:each) do
+        File.write(described_class::CONFIG_PATH, ~<<-EOS)
+          default:
+            layout: fdp
+            graph:
+              splines: ortho
+          theme1:
+            colorscheme: reds
+            layout: fdp
+          theme2:
+            colorscheme: blues
+            layout: dot
+        EOS
+      end
+
+      it 'returns the default value' do
+        theme = described_class.read(nil)
+        expected = {layout:'fdp', graph:{splines:'ortho'}}
+        expect(theme).to eq expected
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dir_friend
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - kyoendo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-29 00:00:00.000000000 Z
+date: 2013-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gviz
@@ -114,11 +114,15 @@ files:
 - lib/dir_friend.rb
 - lib/dir_friend/any.rb
 - lib/dir_friend/command.rb
+- lib/dir_friend/config.rb
+- lib/dir_friend/core_ext.rb
 - lib/dir_friend/d.rb
 - lib/dir_friend/f.rb
 - lib/dir_friend/graph.rb
+- lib/dir_friend/template.yaml
 - lib/dir_friend/version.rb
 - spec/command_spec.rb
+- spec/config_spec.rb
 - spec/dir_friend_spec.rb
 - spec/graph_spec.rb
 - spec/spec_helper.rb
@@ -148,6 +152,7 @@ specification_version: 4
 summary: '`DirFriend` is a tool for visualizing file directory.'
 test_files:
 - spec/command_spec.rb
+- spec/config_spec.rb
 - spec/dir_friend_spec.rb
 - spec/graph_spec.rb
 - spec/spec_helper.rb