keyp 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6fe1096a2986fb5e0c7294dde7465399487f46f
-  data.tar.gz: aa53557b7a5ef2a0ddaf83c5005f653f08e1de25
+  metadata.gz: d98a2fa1da818cd0aec0b3a51abe7d1dd4b8afa4
+  data.tar.gz: 4033012aa8d82fe633552d53520e4e2e1edd0732
 SHA512:
-  metadata.gz: 9728123d215cafbf15881a10b8b43b3fad95e5b6a473fea52ac42f0d28d429b20a4295a1d0fd700f8c71224182fb59c58e122ac1ca308dfab803af7f77170114
-  data.tar.gz: 320ce0f3a9c587b577b5d7b6dd466aac857ecf99fec6208874232324b2d79b23867b1a188d4f22e76a3eb20613156a1e8d49ef1fe33a9f7ad87dc279536acab3
+  metadata.gz: 1cbb72344649affc084601ee562eb99a08f40b05763c0947b4bb955b4165a2a5f5e78ccc974ecb51ebac98e15c930b29eaa8dba05718565f9176bcff40511dc5
+  data.tar.gz: 69b475bbb836067eb02bb45332dcd0ba83baa219f2e9ac435daacc4f3c9a04249271b9ac251e8145457a4aed8b67467773746080e72d8fd331d3b5097d8980c9

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/keyp.png)](http://badge.fury.io/rb/keyp)
+
 # Keyp
 
 Keyp is an executable Ruby gem that manages user/machine specific key/value pairs for your Ruby application.
@@ -16,7 +18,7 @@ for any kind of production code at this point in this gem's lifecycle.
 
 ## Quick Tour
 
-Keyp manages key value pairs in collections. As of version 0.0.1, Keyp refers to collections as *bags*. There is a
+Keyp manages key value pairs in collections. As of version 0.0.4, Keyp refers to collections as *bags*. There is a
 default bag called *default*. Unless you specify a bag name, *default* will be used.
 
 Here are some command line examples showing some basic Keyp functionality using the default bag. Here we set a couple
@@ -90,6 +92,10 @@ TODO: Write detailed usage instructions here
 TODO: Write more detailed documentation, For now, see the quick start above and run the following to see CLI options
     $ keyp --help
 
+## Release Notes
+
+* v 0.0.4 - Fixed missing file error
+
 ## Development plan/Features to implement
 
 * Get basic functionality working soundly backed with effective tests

data/lib/keyp.rb

@@ -115,7 +115,7 @@ module Keyp
   # * +options+ - options are passed through to Bag.new
   #
   def self.bag(name='default', options = {})
-    bag = Keyper.new(name, options)
+    bag = Bag.new(name, options)
     bag
   end
 
@@ -221,223 +221,6 @@ module Keyp
 
   end
 
-  # ----------------------------------------------
-
-  # Some inspiration:
-  # http://stackoverflow.com/questions/2680523/dry-ruby-initialization-with-hash-argument
-  #
-  # TODO: add handling so that keys (hierarchical keys too) are accessed as members instead of
-  # hash access
-  #
-  # TODO: move to own file, rename to "Bag"
-  # TODO: i18n error messages
-  #
-  class Keyper
-
-    attr_reader :keypdir, :dirty
-    attr_accessor :name, :data, :file_hash
-
-    def keypfile
-      File.join(@keypdir, @name+@ext)
-    end
-
-    # We expect
-    # I'm not happy with how creating instance variables works. There must be a cleaner way
-    def initialize(name, options = {})
-      @name = name
-      options.each do |k,v|
-        puts "processing options #{k} = #{v}"
-        instance_variable_set("@#{k}", v) unless v.nil?
-      end
-        # set attributes not set by params
-
-      @keypdir ||= Keyp::home
-      @read_only ||= false
-      @ext ||= Keyp::DEFAULT_EXT
-      #@keypfile = config_path
-      # load our resource
-
-      # load config file into hashes
-      # not the most efficient thing, but simpler and safe enough for now
-
-      unless File.exist? keypfile
-        puts "Keyper.initialize, create_bag #{keypfile}"
-        Keyp::create_bag(name)
-      end
-      file_data = load(keypfile)
-
-      @meta = file_data[:meta]
-      @data = file_data[:data]|| {}
-      @file_hash = file_data[:file_hash]
-      @dirty = false
-    end
-
-    def [](key)
-      @data[key]
-    end
-
-    def []=(key, value)
-      set_prop(key, value)
-    end
-
-    def set_prop(key, value)
-      unless @read_only
-        # TODO: check if data has been modified
-        # maybe there is a way hash tells us its been modified. If not then
-        # just check if key,val is already in hash and matches
-        @data[key] = value
-        @dirty = true
-      else
-        raise "Bag #{@name} is read only"
-      end
-    end
-
-    def delete(key)
-      unless @read_only
-        if @data.key? key
-          @dirty = true
-        end
-        val = @data.delete(key)
-      else
-        raise "Bag #{@name} is read only"
-      end
-      val
-    end
-
-    def empty?
-      @data.empty?
-    end
-
-
-    ##
-    # Adds key/value pairs from this bag to the Ruby ENV
-    # NOTE: Currently in development.
-    # If no options are provided, then all of the bag's key/value pairs will be assigned.
-    #
-    # ==== Options
-    # TBD:
-    #  +:sysvar+ Only use valid system environment vars
-    #  +:selection+ Provide a list of keys to match
-    #  +:overwrite+
-    #  +:no_overwrite+  - This is enabled by default
-    #  +:to_upper
-
-    # Returns a hash of the key/value pairs which have been set
-    # ==== Examples
-    # +add_to_env upper:+
-    # To assign keys matching a pattern:
-    # +add_to_env regex: '\A(_|[A-Z])[a-zA-Z\d]*'
-
-    def add_to_env(options = {})
-      # TODO: Add checking, upcase
-
-      # pattern matching valid env var
-      sys_env_reg = /\A(_|[a-zA-Z])\w*/
-      assigned = {}
-      overwrite = options[:overwrite] || false
-      pattern = options[:sysvar] if options.key?(:sysvar)
-
-      pattern ||= '(...)'
-
-      bag.data.each do |key,value|
-        if pattern.match(key)
-          # TODO: add overwrite checking
-          ENV[key] = value
-          assigned[key] = value
-        end
-      end
-      assigned
-    end
-
-
-    # TODO add from hash
-
-
-    def import(filename)
-      raise "import not yet supported"
-    end
-
-    def export(filename)
-      raise "export not yet supported"
-    end
-
-
-    # TODO: def to_yaml
-    # TODO: def to_json
-    # TODO: def to_s
-
-    ##
-    # Give full path, attempt to load
-    # sticking with YAML format for now
-    # May add new file format later in which case we'll
-    # TODO: consider changing to class method
-    def load (config_path)
-      #config_data = {}
-      # Get extension
-      file_ext = File.extname(config_path)
-
-      # check
-      # only YAML supported for initial version. Will consider adapters to
-      # abstract the persistence layer
-
-
-      # TODO: make this hardcoded case a hash of helpers
-      # TODO: Add two sections: Meta and data, then return as hash
-
-      if file_ext.downcase == Keyp::DEFAULT_EXT
-
-        # Either we are arbitrarily creating directories when
-        # given a path for a file that doesn't exist
-        # or we have special behavior for the default dir
-        # or we just fault and let the caller deal with it
-        unless File.exist? config_path
-          raise "Keyp config file not found: #{config_path}"
-        end
-
-        file_data = YAML.load_file(config_path)
-
-      else
-          raise "Keyp version x only supports YAML for config files. You tried a #{file_ext}"
-      end
-      { meta: file_data['meta'], data: file_data['data']||{}, file_hash: file_data.hash }
-    end
-
-    ##
-    # Saves the Bag to file
-    #
-    # NOT thread safe
-    # TODO: make thread safe
-    def save
-      if @read_only
-        raise "This bag instance is read only"
-      end
-      if @dirty
-        # lock file
-        # read checksum
-        # if checksum matches our saved checksum then update file and release lock
-        # otherwise, raise
-        # TODO: implement merge from updated file and raise only if conflict
-        begin
-          file_data = { 'meta' => @meta, 'data' => @data }
-
-          if File.exist? keypfile
-            read_file_data = load(keypfile)
-            unless @file_hash == read_file_data[:file_hash]
-              raise "Will not write to #{keypfile}\nHashes differ. Expected hash =#{@file_hash}\n" +
-                  "found hash #{read_file_data[:file_hash]}"
-            end
-          end
-          File.open(keypfile, 'w') do |f|
-            f.write file_data.to_yaml
-          end
-          @dirty = false
-        rescue
-          # TODO: log error
-
-        end
-      end
-    end
-  end
 
 
   # Hmm, do we really need this or can we suffice with the meta hash in the bag

data/lib/keyp/bag.rb

@@ -0,0 +1,219 @@
+module Keyp
+  # ----------------------------------------------
+
+  # Some inspiration:
+  # http://stackoverflow.com/questions/2680523/dry-ruby-initialization-with-hash-argument
+  #
+  # TODO: add handling so that keys (hierarchical keys too) are accessed as members instead of
+  # hash access
+  #
+  # TODO: move to own file, rename to "Bag"
+  # TODO: i18n error messages
+  #
+  class Bag
+
+    attr_reader :keypdir, :dirty
+    attr_accessor :name, :data, :file_hash
+
+    def keypfile
+      File.join(@keypdir, @name+@ext)
+    end
+
+    # We expect
+    # I'm not happy with how creating instance variables works. There must be a cleaner way
+    def initialize(name, options = {})
+      @name = name
+      options.each do |k,v|
+        puts "processing options #{k} = #{v}"
+        instance_variable_set("@#{k}", v) unless v.nil?
+      end
+      # set attributes not set by params
+
+      @keypdir ||= Keyp::home
+      @read_only ||= false
+      @ext ||= Keyp::DEFAULT_EXT
+      #@keypfile = config_path
+      # load our resource
+
+      # load config file into hashes
+      # not the most efficient thing, but simpler and safe enough for now
+
+      unless File.exist? keypfile
+        puts "Keyper.initialize, create_bag #{keypfile}"
+        Keyp::create_bag(name)
+      end
+      file_data = load(keypfile)
+
+      @meta = file_data[:meta]
+      @data = file_data[:data]|| {}
+      @file_hash = file_data[:file_hash]
+      @dirty = false
+    end
+
+    def [](key)
+      @data[key]
+    end
+
+    def []=(key, value)
+      set_prop(key, value)
+    end
+
+    def set_prop(key, value)
+      unless @read_only
+        # TODO: check if data has been modified
+        # maybe there is a way hash tells us its been modified. If not then
+        # just check if key,val is already in hash and matches
+        @data[key] = value
+        @dirty = true
+      else
+        raise "Bag #{@name} is read only"
+      end
+    end
+
+    def delete(key)
+      unless @read_only
+        if @data.key? key
+          @dirty = true
+        end
+        val = @data.delete(key)
+      else
+        raise "Bag #{@name} is read only"
+      end
+      val
+    end
+
+    def empty?
+      @data.empty?
+    end
+
+
+    ##
+    # Adds key/value pairs from this bag to the Ruby ENV
+    # NOTE: Currently in development.
+    # If no options are provided, then all of the bag's key/value pairs will be assigned.
+    #
+    # ==== Options
+    # TBD:
+    #  +:sysvar+ Only use valid system environment vars
+    #  +:selection+ Provide a list of keys to match
+    #  +:overwrite+
+    #  +:no_overwrite+  - This is enabled by default
+    #  +:to_upper
+
+    # Returns a hash of the key/value pairs which have been set
+    # ==== Examples
+    # +add_to_env upper:+
+    # To assign keys matching a pattern:
+    # +add_to_env regex: '\A(_|[A-Z])[a-zA-Z\d]*'
+
+    def add_to_env(options = {})
+      # TODO: Add checking, upcase
+
+      # pattern matching valid env var
+      sys_env_reg = /\A(_|[a-zA-Z])\w*/
+      assigned = {}
+      overwrite = options[:overwrite] || false
+      pattern = options[:sysvar] if options.key?(:sysvar)
+
+      pattern ||= '(...)'
+
+      bag.data.each do |key,value|
+        if pattern.match(key)
+          # TODO: add overwrite checking
+          ENV[key] = value
+          assigned[key] = value
+        end
+      end
+      assigned
+    end
+
+
+    # TODO add from hash
+
+
+    def import(filename)
+      raise "import not yet supported"
+    end
+
+    def export(filename)
+      raise "export not yet supported"
+    end
+
+
+    # TODO: def to_yaml
+    # TODO: def to_json
+    # TODO: def to_s
+
+    ##
+    # Give full path, attempt to load
+    # sticking with YAML format for now
+    # May add new file format later in which case we'll
+    # TODO: consider changing to class method
+    def load (config_path)
+      #config_data = {}
+      # Get extension
+      file_ext = File.extname(config_path)
+
+      # check
+      # only YAML supported for initial version. Will consider adapters to
+      # abstract the persistence layer
+
+
+      # TODO: make this hardcoded case a hash of helpers
+      # TODO: Add two sections: Meta and data, then return as hash
+
+      if file_ext.downcase == Keyp::DEFAULT_EXT
+
+        # Either we are arbitrarily creating directories when
+        # given a path for a file that doesn't exist
+        # or we have special behavior for the default dir
+        # or we just fault and let the caller deal with it
+        unless File.exist? config_path
+          raise "Keyp config file not found: #{config_path}"
+        end
+
+        file_data = YAML.load_file(config_path)
+
+      else
+        raise "Keyp version x only supports YAML for config files. You tried a #{file_ext}"
+      end
+      { meta: file_data['meta'], data: file_data['data']||{}, file_hash: file_data.hash }
+    end
+
+    ##
+    # Saves the Bag to file
+    #
+    # NOT thread safe
+    # TODO: make thread safe
+    def save
+      if @read_only
+        raise "This bag instance is read only"
+      end
+      if @dirty
+        # lock file
+        # read checksum
+        # if checksum matches our saved checksum then update file and release lock
+        # otherwise, raise
+        # TODO: implement merge from updated file and raise only if conflict
+        begin
+          file_data = { 'meta' => @meta, 'data' => @data }
+
+          if File.exist? keypfile
+            read_file_data = load(keypfile)
+            unless @file_hash == read_file_data[:file_hash]
+              raise "Will not write to #{keypfile}\nHashes differ. Expected hash =#{@file_hash}\n" +
+                        "found hash #{read_file_data[:file_hash]}"
+            end
+          end
+          File.open(keypfile, 'w') do |f|
+            f.write file_data.to_yaml
+          end
+          @dirty = false
+        rescue
+          # TODO: log error
+
+        end
+      end
+    end
+  end
+end

data/lib/keyp/version.rb

@@ -1,3 +1,3 @@
 module Keyp
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/keyp_spec.rb

@@ -5,7 +5,7 @@ describe Keyp do
   context "CONSTANTS" do
     it 'should return correct version string' do
       #Keyp.version_string.should == "Keyp version #{Keyp::VERSION}"
-      Keyp::VERSION.should == '0.0.3'
+      Keyp::VERSION.should == '0.0.4'
     end
 
     it 'should specify default store' do

data/spec/keyper_spec.rb

@@ -1,11 +1,11 @@
 require 'spec_helper'
 
-describe Keyp::Keyper do
+describe Keyp::Bag do
 
   context "is empty" do
     before (:each) do
       puts "before : is empty"
-      @bag = Keyp::Keyper.new 'testing123'
+      @bag = Keyp::Bag.new 'testing123'
     end
 
     it "should return an empty hash" do
@@ -20,7 +20,7 @@ describe Keyp::Keyper do
   context "is not empty" do
     before (:each) do
       puts "before : is not empty"
-      @bag = Keyp::Keyper.new 'grue_eats_you'
+      @bag = Keyp::Bag.new 'grue_eats_you'
       @bag['LIGHTS'] = 'out'
     end
     it "should return a non-empty hash" do
@@ -32,7 +32,7 @@ describe Keyp::Keyper do
     before (:each) do
       # TODO: pseudo random bag name generation to a helper
       bag_name = "grue_eats_you_when_it_is_dark_#{Time.now.strftime("%Y%m%d%H%M")}"
-      @bag = Keyp::Keyper.new bag_name
+      @bag = Keyp::Bag.new bag_name
     end
     it "should copy all vars"
 =begin

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keyp
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - John Baldwin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-30 00:00:00.000000000 Z
+date: 2014-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
@@ -83,6 +83,7 @@ files:
 - bin/keyp
 - keyp.gemspec
 - lib/keyp.rb
+- lib/keyp/bag.rb
 - lib/keyp/cli.rb
 - lib/keyp/version.rb
 - spec/keyp_spec.rb