keep 0.0.1

data/LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License
+
+Copyright (c) Zach Holman, http://zachholman.com
+
+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,29 @@
+# Keep
+
+It makes keeping config information pretty easy.
+
+## Install
+
+    gem install keep
+
+## Usage
+
+    require 'keep'
+    keep = Keep.new('config/settings.yml')
+    keep.set(:password,'Ellen Page')
+    keep.get(:password)
+
+Just tell Keep where to keep things, then give it a hash of what to keep and
+what the value is.
+
+Keep currently serializes to YAML (although different backends are likely to
+come next- pull requests welcome).
+
+## More
+
+    keep = Keep.new('config/settings.yml')
+    keep.present?(:password)
+
+## Other important information
+
+Nothing else is important.

data/Rakefile

@@ -0,0 +1,150 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Generate RCov test coverage and open in your browser"
+task :coverage do
+  require 'rcov'
+  sh "rm -fr coverage"
+  sh "rcov test/test_*.rb"
+  sh "open coverage/index.html"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/keep.gemspec

@@ -0,0 +1,71 @@
+## This is the rakegem gemspec template. Make sure you read and understand
+## all of the comments. Some sections require modification, and others can
+## be deleted if you don't need them. Once you understand the contents of
+## this file, feel free to delete any comments that begin with two hash marks.
+## You can find comprehensive Gem::Specification documentation, at
+## http://docs.rubygems.org/read/chapter/20
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  ## Leave these as is they will be modified for you by the rake gemspec task.
+  ## If your rubyforge_project name is different, then edit it and comment out
+  ## the sub! line in the Rakefile
+  s.name              = 'keep'
+  s.version           = '0.0.1'
+  s.date              = '2011-02-17'
+  s.rubyforge_project = 'keep'
+
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "It makes keeping config information pretty easy."
+  s.description = "A standardized library to persist config information to disk."
+
+  ## List the primary authors. If there are a bunch of authors, it's probably
+  ## better to set the email to an email list or something. If you don't have
+  ## a custom homepage, consider using your GitHub URL or the like.
+  s.authors  = ["Zach Holman"]
+  s.email    = 'hello@zachholman.com'
+  s.homepage = 'https://github.com/holman/keep'
+
+  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
+  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
+  s.require_paths = %w[lib]
+
+  ## Specify any RDoc options here. You'll want to add your README and
+  ## LICENSE files to the extra_rdoc_files list.
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md LICENSE.md]
+
+  ## List your runtime dependencies here. Runtime dependencies are those
+  ## that are needed for an end user to actually USE your code.
+  #s.add_dependency('DEPNAME', [">= 1.1.0", "< 2.0.0"])
+
+  ## List your development dependencies here. Development dependencies are
+  ## those that are only needed during development
+  #s.add_development_dependency('DEVDEPNAME', [">= 1.1.0", "< 2.0.0"])
+
+  ## Leave this section as-is. It will be automatically generated from the
+  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
+  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
+  # = MANIFEST =
+  s.files = %w[
+    LICENSE.md
+    README.md
+    Rakefile
+    keep.gemspec
+    lib/keep.rb
+    lib/keep/disk.rb
+    lib/keep/yaml.rb
+    test/helper.rb
+    test/test_disk.rb
+    test/test_keep.rb
+    test/test_yaml.rb
+  ]
+  # = MANIFEST =
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+end

data/lib/keep/disk.rb

@@ -0,0 +1,73 @@
+# Keep::Disk is our hook into your system. We'll save and open files here.
+#
+# Pretty cool, amirite?
+class Keep
+  class Disk
+
+    # The path to save the file.
+    #
+    # Returns a String path to the file.
+    attr_reader :path
+
+    # The path to save the file.
+    #
+    #   path - String file path (relative or absolute) destination
+    #
+    # Returns a String path to the file.
+    attr_writer :path
+
+    # Creates a new Disk instance.
+    #
+    # Returns nothing.
+    def initialize(path)
+      @path = path
+      touch
+    end
+
+    # Ensures the destination file is created.
+    #
+    # Returns nothing.
+    def touch
+      FileUtils.touch(path)
+    end
+
+    # The in-memory data structure representing the configuration you're
+    # keeping. Implemented by child classes.
+    #
+    # Returns a Hash of configuration keys and values.
+    def data ; end
+
+    # Persists the in-memory hash to disk. Implemented by child classes.
+    #
+    # Returns whether the save was successful.
+    def save ; end
+
+    # Sets a value to a given key. Updates the in-memory hash, and then saves.
+    #
+    #   key - a String value for the key of this Hash
+    #   value - an Object that maps to the key, will be serialized
+    #
+    # Returns whether the save was successful.
+    def set(key,value)
+      data[key.to_s] = value
+      save
+    end
+
+    # Returns the value of the specified key.
+    #
+    #   key - a String value for the key of this Hash
+    #
+    # Returns the value if found, otherwise nil.
+    def get(key)
+      data[key.to_s]
+    end
+
+    # Searches for the key in the in-memory Hash.
+    #
+    # Returns whether or not the key is present.
+    def present?(key)
+      !get(key).nil?
+    end
+
+  end
+end

data/lib/keep/yaml.rb

@@ -0,0 +1,22 @@
+class Keep
+  class Yaml < Disk
+
+    # The in-memory data structure representing the configuration you're
+    # keeping. Implemented by child classes.
+    #
+    # Returns a Hash of configuration keys and values.
+    def data
+      @data ||= YAML::load_file(path) || {}
+    end
+
+    # Persists the in-memory hash to disk. Implemented by child classes.
+    #
+    # Returns whether the save was successful.
+    def save
+      File.open(path, 'w') do |out|
+        YAML.dump(data, out)
+      end
+    end
+
+  end
+end

data/lib/keep.rb

@@ -0,0 +1,80 @@
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+
+require 'fileutils'
+require 'yaml'
+
+require 'keep/disk'
+require 'keep/yaml'
+
+class Keep
+  VERSION = '0.0.1'
+
+  # The path to the configuration file.
+  attr_reader :path
+
+  # The in-memory Disk object.
+  attr_reader :disk
+
+  # The configuration format outputted.
+  attr_reader :format
+
+  # The path to the configuration file.
+  #
+  #   path - a String file path (absolute or relative)
+  #
+  # Returns a String.
+  attr_writer :path
+
+  # A reference to the in-memory Disk object.
+  attr_writer :disk
+
+  # The format of the configuration output.
+  attr_writer :format
+
+
+  # Initialize a new Keep instance.
+  #
+  #   path - the String file path to save configuration to
+  #
+  # Returns nothing.
+  def initialize(path)
+    @path = path
+    @disk = Yaml.new(path)
+  end
+
+  # The format of configuration output.
+  #
+  #   format - the lowercase String representation of a class inheriting Disk
+  #
+  # Returns nothing, defaults to 'yaml' right now.
+  def as(format)
+    @format = 'yaml'
+  end
+
+  # Sets a value to a given key.
+  #
+  #   key - a String value for the key of this Hash
+  #   value - an Object that maps to the key, will be serialized
+  #
+  # Returns whether the save was successful. 
+  def set(key,value)
+    @disk.set(key,value)
+  end
+
+  # Returns the value of the specified key.
+  #
+  #   key - a String value for the key of this Hash
+  #
+  # Returns the value if found, otherwise nil.
+  def get(key)
+    @disk.get(key)
+  end
+
+  # Searches for the key in the in-memory Hash.
+  #
+  # Returns whether or not the key is present.
+  def present?(key)
+    @disk.present?(key)
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,14 @@
+# coding: utf-8
+
+require 'test/unit'
+
+begin
+  require 'rubygems'
+  require 'redgreen'
+rescue LoadError
+end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'keep'

data/test/test_disk.rb

@@ -0,0 +1,22 @@
+require 'helper'
+
+class TestDisk < Test::Unit::TestCase
+
+  def setup
+    @path = '/tmp/keep-disk-test'
+    @disk = Keep::Disk.new(@path)
+  end
+
+  def teardown
+    `rm -rf #{@path}`
+  end
+
+  def test_path
+    assert_equal @path, @disk.path
+  end
+
+  def test_touch
+    assert File.exist?(@path)
+  end
+
+end

data/test/test_keep.rb

@@ -0,0 +1,22 @@
+require 'helper'
+
+class TestKeeps < Test::Unit::TestCase
+
+  def setup
+    @path = '/tmp/keep-test'
+    @keep = Keep.new(@path)
+  end
+
+  def teardown
+    `rm -rf #{@path}`
+  end
+
+  def test_path
+    assert_equal @path, @keep.path
+  end
+
+  def test_as
+    assert_equal 'yaml', @keep.as('yaml')
+  end
+
+end

data/test/test_yaml.rb

@@ -0,0 +1,35 @@
+require 'helper'
+
+class TestKeep < Test::Unit::TestCase
+
+  def setup
+    @path = '/tmp/keep-yaml-test'
+    @yaml = Keep::Yaml.new(@path)
+  end
+
+  def teardown
+    `rm -rf #{@path}`
+  end
+
+  def test_set
+    @yaml.set('cute', 'ellen page')
+    assert_equal "--- \ncute: ellen page", File.read(@path).chomp
+  end
+
+  def test_get_symbol
+    @yaml.set('cute', 'ellen page')
+    assert_equal 'ellen page', @yaml.get(:cute)
+  end
+
+  def test_get_string
+    @yaml.set('cute', 'ellen page')
+    assert_equal 'ellen page', @yaml.get('cute')
+  end
+
+  def test_present
+    assert !@yaml.present?('cute')
+    @yaml.set('cute', 'ellen page')
+    assert @yaml.present?('cute')
+  end
+
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: keep
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Zach Holman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-17 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: A standardized library to persist config information to disk.
+email: hello@zachholman.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- LICENSE.md
+files: 
+- LICENSE.md
+- README.md
+- Rakefile
+- keep.gemspec
+- lib/keep.rb
+- lib/keep/disk.rb
+- lib/keep/yaml.rb
+- test/helper.rb
+- test/test_disk.rb
+- test/test_keep.rb
+- test/test_yaml.rb
+has_rdoc: true
+homepage: https://github.com/holman/keep
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: keep
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 2
+summary: It makes keeping config information pretty easy.
+test_files: 
+- test/test_disk.rb
+- test/test_keep.rb
+- test/test_yaml.rb