cabi 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb182df9ed5993329f7ae5ab75021a2841c95a1d
-  data.tar.gz: 99cb126fd223820989b2dd16e7df542426834bd1
+  metadata.gz: cec2656830ddd4ae65fba64c3821363be983765b
+  data.tar.gz: 25638dce3ba1f2f014f2629e190cf9ca9a7af450
 SHA512:
-  metadata.gz: 6b1ae9a7cb08d2353d3dc25b43f59c5de4e7bc2db01aca962d65fbfaf6e527477553ea1f159cf83e6ce2b7494a120c8be838211919c699d36eef27f133426200
-  data.tar.gz: ca256fb320b45f733c92b2ea772ca4c78fa73e7fab9009ff71aef7cbd8e22bae285c8bc840e4e3ec913e61e2dcdb6ecc6e0d67475bfbd46fcf6e1e3cec052a3f
+  metadata.gz: 5ebf6f96dd020f6ac2149ce3b6a2c47a584270d0a3e031d5b239ddbe197b1be4c1401884c9c75841ecb7f37269ebe7fc415d880ff1c27ac754c157992f4a3f28
+  data.tar.gz: ba777a2f2eaa0f25048341d9c72ef93fbe360782b015c51954f6add362bc3667e66232aae71cb8dcf9d1bf368003df2b570b29ba049276db36304ceb46090c9a

data/README.md

@@ -8,7 +8,7 @@ Cabi is a flat-file datastore where data is stored by directory stucture and acc
 
 ``` bash
 $ gem install cabi
-$ cabi init --mock    # use --mock to init cabi cache with some fake data
+$ cabi init --mock    # use --mock to init cabi data with some fake data
 ```
 
 Then access your data like so:
@@ -22,7 +22,7 @@ $ irb
 
 ### Usage
 
-Assuming your `cabi-cache` folder has the following structure:
+Assuming your `cabi-data` folder has the following structure:
 
     .
     ├── info.yml
@@ -55,18 +55,18 @@ Cabi.read('posts:some-article:index.html')    # contents of posts/some-article/i
 # selection will work.
 Cabi.read('pages:about:*')                    # an array of body.html and meta.yml contents
 Cabi.read('pages:about:person-*')             # an array of all person-* html files
-Cabi.read('**/**')                            # an array of all files in cache
+Cabi.read('**/*')                             # an array of all files in data
 
 # Selection within YAML files
 Cabi.read('pages:about:meta:foo:bar')         # contents of ['foo']['bar'] in page/about/meta.yml hash
 Cabi.read('info:foo:bar:baz')                 # contents of ['foo']['bar']['baz'] in info.yml hash
 ```
 
-### Custom Cache Directory
+### Custom Data Directory
 
-Cabi assumes that your cache directory is either a folder at the top level of your project with a `.cabi-cache` file in it (to indicate that it's the cache directory). If one is not found, the cache directory defaults to `./cabi-cache`.
+Cabi assumes that your data directory is either a folder at the top level of your project with a `.cabi-data` file in it (to indicate that it's the data directory). If one is not found, the data directory defaults to `./cabi-data`.
 
-For instance, if you had a folder called `super-cache` located inside of your project's root that had a file called `.cabi-cache` inside of it, this folder would be treated as your cache directory.
+For instance, if you had a folder called `super-data` located inside of your project's root that had a file called `.cabi-data` inside of it, this folder would be treated as your data directory.
 
 ### Icon <img src="https://rawgithub.com/briangonzalez/cabi-gem/master/data/cabi.svg" width=20 style="margin-right: 10px">
 

data/bin/cabi

@@ -6,33 +6,33 @@ require File.join( File.expand_path("../..", __FILE__), "lib", "cabi")
 
 class CabiCLI < Thor
 
-  desc "init", "Initialize Cabi cache directory (use --mock to create fake data, use --target to specify your own directory)"
+  desc "init", "Initialize Cabi data directory (use --mock to create fake data, use --target to specify your own directory)"
   method_options :mock => :boolean, :target => :string
   def init
     
-    target = options[:target] || Cabi::CABI_CACHE_DIR
+    target = options[:target] || Cabi::CABI_DATA_DIR
     FileUtils.mkdir( target )
 
     if options[:mock]
-      f = File.expand_path( "../../data/cabi-cache.tar.gz", __FILE__ )
-      `tar -xf #{f} --strip-components=2 -C #{target}`
+      f = File.expand_path( "../../data/cabi-data.tar.gz", __FILE__ )
+      `tar -xf #{f} --strip-components=1 -C #{target}`
     end
 
-    puts " ** Cabi cache created in #{target}"
+    puts " ** Cabi data created in #{target}"
   end
 
-  desc "clean", "Remove Cabi cache directory"
+  desc "clean", "Remove Cabi data directory"
   method_options :force => :boolean  
   def clean
     if options[:force]
       begin
-        FileUtils.rm_rf( Cabi.cache_dir )
-        FileUtils.rm_rf( Cabi::CABI_CACHE_DIR)
-        puts " ** Cleaned cabi cache" 
+        FileUtils.rm_rf( Cabi.data_dir )
+        FileUtils.rm_rf( Cabi::CABI_DATA_DIR)
+        puts " ** Cleaned cabi data" 
       rescue Exception => e
       end
     else
-      puts " ** Not cleaning cabi cache without --force" 
+      puts " ** Not cleaning cabi data folder without --force" 
     end
   end
 

data/cabi.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name                  = 'cabi'
-  s.version               = '0.1.1'
+  s.version               = '0.1.2'
   s.summary               = "A simple, flat-file datastore for Ruby."
           
   s.description           = "Cabi is a flat-file datastore where data is stored by directory stucture and accessed by colon-delimited strings."

data/lib/cabi.rb

@@ -10,15 +10,15 @@ module Cabi
   DELIMITER       = ':'
   BULK_SELECTOR   = '*'
   YAML_EXT        = '.yml'
-  CABI_CACHE_ID   = '.cabi-cache'
-  CABI_CACHE_DIR  = './cabi-cache'
+  CABI_DATA_ID   = '.cabi-data'
+  CABI_DATA_DIR   = './cabi-data'
 
   def self.read(id)
-    Cache.read(id)
+    Data.read(id)
   end
 
   def self.write(id, content)
-    Cache.write(id, content)
+    Data.write(id, content)
   end
 
 end

data/lib/data.rb

@@ -0,0 +1,39 @@
+module Cabi
+
+  class Data
+
+      def self.read(id)
+        DataFile.contents(id) || nil
+      end
+
+      def self.write(id, content)
+        file = DataFile.write(id, content)
+      end
+
+      def self.user_data_dir
+        dir = false
+
+        Dir.foreach('.') do |item|
+          next if item == '..' or !File.directory?(item)
+          dir = item if File.exists?( File.join(item, CABI_DATA_ID) )
+          break if dir
+        end
+
+        dir
+      end
+
+  end
+
+  # Helpers for setting/getting data dir.
+  def self.data_dir
+    dir             = Data.user_data_dir || CABI_DATA_DIR
+    @@data_dir      = File.expand_path(dir)
+    raise LoadError.new "Could not find cabi data folder!" unless File.exists? @@data_dir
+    @@data_dir
+  end
+
+  def self.reset_data_dir
+    @@data_dir = nil
+  end
+
+end

data/lib/datafile.rb

@@ -64,7 +64,7 @@ module Cabi
 
     def self.id_array(id)
       id = id.split( DELIMITER )
-      [Cabi.cache_dir] + id
+      [Cabi.data_dir] + id
     end
 
     def self.exists?(id)
@@ -94,7 +94,7 @@ module Cabi
       id.each_with_index do |key, index|
         break if val
 
-        a                 =  [Cabi.cache_dir] + id[0..index] 
+        a                 =  [Cabi.data_dir] + id[0..index] 
         a[ a.length - 1 ] =  a[a.length - 1 ] + YAML_EXT
         f = File.join( *a )
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cabi
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Brian Gonzalez
@@ -43,10 +43,10 @@ files:
 - cabi.gemspec
 - bin/cabi
 - lib/cabi.rb
-- lib/cache.rb
+- lib/data.rb
 - lib/datafile.rb
 - lib/hash.rb
-- data/cabi-cache.tar.gz
+- data/cabi-data.tar.gz
 - data/cabi.svg
 homepage: http://github.com/briangonzalez/cabi-gem
 licenses:

data/lib/cache.rb

@@ -1,39 +0,0 @@
-module Cabi
-
-  class Cache
-
-      def self.read(id)
-        DataFile.contents(id) || nil
-      end
-
-      def self.write(id, content)
-        file = DataFile.write(id, content)
-      end
-
-      def self.user_cache_dir
-        dir = false
-
-        Dir.foreach('.') do |item|
-          next if item == '..' or !File.directory?(item)
-          dir = item if File.exists?( File.join(item, CABI_CACHE_ID) )
-          break if dir
-        end
-
-        dir
-      end
-
-  end
-
-  # Helpers for setting/getting cache dir.
-  def self.cache_dir
-    dir             = Cache.user_cache_dir || CABI_CACHE_DIR
-    @@cache_dir     = File.expand_path(dir)
-    raise LoadError.new "Could not find cabi cache folder!" unless File.exists? @@cache_dir
-    @@cache_dir
-  end
-
-  def self.reset_cache_dir
-    @@cache_dir = nil
-  end
-
-end