user_config 0.0.0 → 0.0.1

data/Rakefile

@@ -18,7 +18,7 @@ Jeweler::Tasks.new do |gem|
   gem.homepage = "http://github.com/ytaka/user_config"
   gem.license = "GPLv3"
   gem.summary = "Management of configuration files in a user's home directory"
-  gem.description = "The liburary creates, saves, and loads configuruation files, which are in a user's home directory or a specified directory."
+  gem.description = "The library creates, saves, and loads configuration files, which are in a user's home directory or a specified directory."
   gem.email = "d@ytak.info"
   gem.authors = ["Takayuki YAMAGUCHI"]
   # dependencies defined in Gemfile

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.0.1

data/lib/user_config.rb

@@ -1,21 +1,27 @@
 require 'fileutils'
 require 'yaml'
+require 'pathname'
 
 class UserConfig
-  @@default_value = {}
+  def self.default_value
+    unless @default_value
+      @default_value = {}
+    end
+    @default_value
+  end
 
   def self.default(path, default_hash)
-    @@default_value[path] = default_hash
+    self.default_value[path] = default_hash
   end
 
   attr_reader :directory
 
   # +directory_name+ is a name of a configuration directory.
-  # opts[:root] is root directory, of which default value is ENV['HOME'].
+  # opts[:home] is root directory, of which default value is ENV['HOME'].
   # opts[:permission] is a file permission of the configuration directory,
   # of which default value is 0700.
   def initialize(directory_name, opts = {})
-    @directory = File.expand_path(File.join(opts[:root] || ENV['HOME'], directory_name))
+    @directory = File.expand_path(File.join(opts[:home] || ENV['HOME'], directory_name))
     @file = {}
     unless File.exist?(@directory)
       FileUtils.mkdir_p(@directory)
@@ -24,11 +30,14 @@ class UserConfig
   end
 
   def file_path(path)
+    if Pathname(path).absolute?
+      raise ArgumentError, "Path '#{path}' is absolute."
+    end
     File.join(@directory, path)
   end
 
   def default_value(path)
-    @@default_value[path] || {}
+    self.class.default_value[path] || {}
   end
   private :default_value
 
@@ -53,6 +62,7 @@ class UserConfig
     if opts[:mode]
       FileUtils.chmod(fpath, opts[:mode])
     end
+    fpath
   end
 
   # Load the configuration file of +path+.
@@ -62,7 +72,7 @@ class UserConfig
 
   alias_method :[], :load
 
-  # Return an array of paths of all files.
+  # Return an array of paths of all cached files.
   def all_file_paths
     @file.map do |ary|
       file_path(ary[0])
@@ -76,6 +86,69 @@ class UserConfig
     end
   end
 
+  # Return full path if +path+ exists under the configuration directory.
+  # Otherwise, false.
+  def exist?(path)
+    fpath = file_path(path)
+    File.exist?(fpath) ? fpath : false
+  end
+
+  # Delete a file of +path+.
+  def delete(path)
+    if path.size > 0
+      FileUtils.rm_r(file_path(path))
+    else
+      raise ArgumentError, "Path string is empty."
+    end
+  end
+
+  # List files in directory +dir+.
+  # If opts[:absolute] is true, return an array of absolute paths.
+  def list_in_directory(dir, opts = {})
+    fpath = file_path(dir)
+    if File.directory?(fpath)
+      files = Dir.entries(fpath).delete_if do |d|
+        /^\.+$/ =~ d
+      end.sort
+      if opts[:absolute]
+        files.map! do |path|
+          File.join(fpath, path)
+        end
+      end
+      files
+    else
+      nil
+    end
+  end
+
+  # Open file of +path+ with +mode+.
+  def open(path, mode, &block)
+    fpath = file_path(path)
+    unless File.exist?((dir = File.dirname(fpath)))
+      FileUtils.mkdir_p(dir)
+    end
+    f = Kernel.open(fpath, mode)
+    if block_given?
+      begin
+        yield(f)
+      ensure
+        f.close
+      end
+    else
+      f
+    end
+  end
+
+  # Read file of +path+ and return a string.
+  def read(path)
+    fpath = file_path(path)
+    if File.exist?(fpath)
+      File.read(fpath)
+    else
+      nil
+    end
+  end
+
   class YAMLFile
     attr_reader :path
 
@@ -109,8 +182,8 @@ class UserConfig
       unless File.exist?((dir = File.dirname(path)))
         FileUtils.mkdir_p(dir)
       end
-      open(path, 'w') do |f|
-        f.print to_yaml
+      Kernel.open(path, 'w') do |f|
+        YAML.dump(@cache, f)
       end
     end
 

data/spec/user_config_spec.rb

@@ -1,30 +1,39 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
+class UserConfigCustom < UserConfig
+end
+
 describe UserConfig do
   before(:all) do
-    @root = File.join(File.dirname(__FILE__), 'config')
-    if File.exist?(@root)
-      raise "Temporary configuration directory '#{@root}' exists."
+    @home = File.join(File.dirname(__FILE__), 'config')
+    if File.exist?(@home)
+      raise "Temporary configuration directory '#{@home}' exists."
     end
   end
 
   subject do
-    UserConfig.new('test', :root => @root)
+    UserConfig.new('test', :home => @home)
   end
 
   it "should return directory" do
-    uconf = UserConfig.new('dir1', :root => @root)
-    uconf.directory.should == File.expand_path(File.join(@root, 'dir1'))
+    uconf = UserConfig.new('dir1', :home => @home)
+    uconf.directory.should == File.expand_path(File.join(@home, 'dir1'))
   end
 
   it "should create directory" do
-    uconf = UserConfig.new('dir2', :root => @root)
-    File.exist?(File.join(@root, 'dir2')).should be_true
+    uconf = UserConfig.new('dir2', :home => @home)
+    File.exist?(File.join(@home, 'dir2')).should be_true
   end
 
   it "should return file path under the directory" do
-    uconf = UserConfig.new('dir3', :root => @root)
-    uconf.file_path('path.yaml').should == File.join(@root, 'dir3', 'path.yaml')
+    uconf = UserConfig.new('dir3', :home => @home)
+    uconf.file_path('path.yaml').should == File.join(@home, 'dir3', 'path.yaml')
+  end
+
+  it "should raise error" do
+    lambda do
+      subject.file_path('/abc/def.yaml')
+    end.should raise_error ArgumentError
   end
 
   it "should set default value" do
@@ -86,7 +95,76 @@ describe UserConfig do
     File.read(full_path).should match(/^third/)
   end
 
+  it "should return false" do
+    subject.exist?('not_exist/file.yaml').should_not be_true
+  end
+
+  it "should return path" do
+    path = 'exist/file.yaml'
+    subject.create(path)
+    subject.exist?(path).should == File.join(subject.directory, path)
+  end
+
+  it "should delete a file" do
+    path = 'delete/file.yaml'
+    subject.create(path)
+    subject.delete(path)
+    subject.exist?(path).should_not be_true
+  end
+
+  it "should return nil" do
+    subject.list_in_directory('not_exist2/').should be_nil
+  end
+
+  it "should return list of files" do
+    files = ['list/file1.yaml', 'list/file2.yaml']
+    files.each do |path|
+      subject.create(path)
+    end
+    subject.list_in_directory('list').should == files.map do |path|
+      path.sub(/^list\//, '')
+    end
+  end
+
+  it "should return list of files of absolute path" do
+    files = ['list2/file1.yaml', 'list2/file2.yaml']
+    files.each do |path|
+      subject.create(path)
+    end
+    subject.list_in_directory('list2', :absolute => true).should == files.map do |path|
+      File.join(subject.directory, path)
+    end
+  end
+
+  it "should save a raw file" do
+    path ='save/raw/hello.txt'
+    subject.open(path, 'w') do |f|
+      f.puts 'hello world'
+    end
+    fpath = File.join(subject.directory, path)
+    File.exist?(fpath).should be_true
+    File.read(fpath).strip.should == 'hello world'
+  end
+
+  it "should read a file" do
+    path ='save/raw/hello.txt'
+    subject.open(path, 'w') do |f|
+      f.puts 'hello world'
+    end
+    fpath = File.join(subject.directory, path)
+    subject.read(path).should == File.read(fpath)
+  end
+
+  it "should return nil" do
+    subject.read('not_exist/file.yaml').should be_nil
+  end
+
+  it "should have different default value" do
+    UserConfigCustom.default_value.should be_an_instance_of Hash
+    UserConfig.default_value.object_id.should_not == UserConfigCustom.default_value.object_id
+  end
+
   after(:all) do
-    FileUtils.rm_r(@root)
+    FileUtils.rm_r(@home)
   end
 end

data/user_config.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{user_config}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Takayuki YAMAGUCHI"]
+  s.date = %q{2011-07-03}
+  s.description = %q{The library creates, saves, and loads configuration files, which are in a user's home directory or a specified directory.}
+  s.email = %q{d@ytak.info}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/user_config.rb",
+    "spec/spec_helper.rb",
+    "spec/user_config_spec.rb",
+    "spec/yaml/test_load.yaml",
+    "spec/yaml_file_spec.rb",
+    "user_config.gemspec"
+  ]
+  s.homepage = %q{http://github.com/ytaka/user_config}
+  s.licenses = ["GPLv3"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Management of configuration files in a user's home directory}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 2.6.0"])
+      s.add_development_dependency(%q<yard>, [">= 0.7.2"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 1.6.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 2.6.0"])
+      s.add_dependency(%q<yard>, [">= 0.7.2"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, [">= 1.6.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 2.6.0"])
+    s.add_dependency(%q<yard>, [">= 0.7.2"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, [">= 1.6.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

metadata

@@ -2,7 +2,7 @@
 name: user_config
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors: 
 - Takayuki YAMAGUCHI
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-02 00:00:00 +09:00
+date: 2011-07-03 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -68,7 +68,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: *id005
-description: The liburary creates, saves, and loads configuruation files, which are in a user's home directory or a specified directory.
+description: The library creates, saves, and loads configuration files, which are in a user's home directory or a specified directory.
 email: d@ytak.info
 executables: []
 
@@ -90,6 +90,7 @@ files:
 - spec/user_config_spec.rb
 - spec/yaml/test_load.yaml
 - spec/yaml_file_spec.rb
+- user_config.gemspec
 has_rdoc: true
 homepage: http://github.com/ytaka/user_config
 licenses: 
@@ -104,7 +105,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1756290468622593776
+      hash: 2431112138724354384
       segments: 
       - 0
       version: "0"