cabi 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83fa2db5429675243c8acd14559770b0f65fd5f2
-  data.tar.gz: 5fb58665d172b8e4ba324fc316fea0fc50ec2436
+  metadata.gz: eb182df9ed5993329f7ae5ab75021a2841c95a1d
+  data.tar.gz: 99cb126fd223820989b2dd16e7df542426834bd1
 SHA512:
-  metadata.gz: b4d55e6e7c80c0c49565eeffe659866662adac9b4668faab05f11c73b315816af9902044cd313e6814b26069a3dea09727ccf85960cd2210c15104801af40b90
-  data.tar.gz: 34b74e174b4396ec9d7073bb501549e8a98e8c0dd7eca7d92882aad6d0bc2e26b592ae87abb3449485f9859a9c05bf8feabbb1122030e1fe4fd74c28d4c9dc9a
+  metadata.gz: 6b1ae9a7cb08d2353d3dc25b43f59c5de4e7bc2db01aca962d65fbfaf6e527477553ea1f159cf83e6ce2b7494a120c8be838211919c699d36eef27f133426200
+  data.tar.gz: ca256fb320b45f733c92b2ea772ca4c78fa73e7fab9009ff71aef7cbd8e22bae285c8bc840e4e3ec913e61e2dcdb6ecc6e0d67475bfbd46fcf6e1e3cec052a3f

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
+$ cabi init --mock    # use --mock to init cabi cache with some fake data
 ```
 
 Then access your data like so:
@@ -16,7 +16,7 @@ Then access your data like so:
 ```bash
 $ irb
   > require 'cabi'
-  > Cabi::Cache.read('pages:about:body')
+  > Cabi.read('pages:about:body')
     => "<h1>Hello, Cabi!</h1>"
 ```
 
@@ -24,29 +24,42 @@ $ irb
 
 Assuming your `cabi-cache` folder has the following structure:
 
-    - my-project
-      |
-      |--cabi-cache
-        |-- info.yml
-        |-- pages
-        |    |-- about 
-        |         |-- body.html
-        |         |-- meta.yml
-        |         
-        |-- posts
-          |-- some-article
-                |-- index.html
-                |-- nav.html
+    .
+    ├── info.yml
+    ├── nav.yml
+    ├── pages
+    │   └── about
+    │       ├── body.html
+    │       ├── meta.yml
+    │       ├── person-1.html
+    │       ├── person-2.html
+    │       └── person-3.html
+    └── posts
+        └── random-article
+            ├── index.html
+            └── nav.html
             
 
 You could then query your data like so:
 
 ```ruby
-Cabi.read('pages:about:body')                # returns contents of page/about/body.html
-Cabi.read('pages:about:meta:foo:bar')        # returns contents of ['foo']['bar'] in page/about/meta.yml hash
-Cabi.read('info:foo:bar:baz')                # returns contents of ['foo']['bar']['baz'] in info.yml hash
-Cabi.read('posts:some-article:index')        # returns contents of posts/some-article/index.html
-Cabi.read('posts:some-article:index.html')   # returns contents of posts/some-article/index.html
+# Simple selection
+Cabi.read('pages:about:body')                 # contents of page/about/body.html
+
+# Selection with/without explicit file extension
+Cabi.read('posts:some-article:index')         # contents of posts/some-article/index.html
+Cabi.read('posts:some-article:index.html')    # contents of posts/some-article/index.html
+
+# Bulk selection - since Cabi uses dir globbing 
+# under the hood, any valid dir glob in your 
+# 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
+
+# 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
@@ -55,13 +68,18 @@ Cabi assumes that your cache directory is either a folder at the top level of yo
 
 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.
 
-### Questions?
-
-Find me online [@brianmgonzalez](http://twitter.com/brianmgonzalez)
-
 ### Icon <img src="https://rawgithub.com/briangonzalez/cabi-gem/master/data/cabi.svg" width=20 style="margin-right: 10px">
 
 [Cabi Icon](http://thenounproject.com/noun/file-cabinet/#icon-No22117) designed by Michela Tannoia, from The Noun Project.
 
 ### Tests
-Run the test suite by running `rake test` in the parent directory.
+Run the test suite by running `rake test` in the parent directory.
+
+### Building Gem Manually
+```bash
+$ gem build cabi.gemspec
+$ gem install ./cabi-<VERSION>.gem
+```
+
+### Questions?
+Find me online [@brianmgonzalez](http://twitter.com/brianmgonzalez)

data/bin/cabi

@@ -2,7 +2,7 @@
 require "thor"
 require "fileutils"
 
-CACHE_DIR = 'cabi-cache'
+require File.join( File.expand_path("../..", __FILE__), "lib", "cabi")
 
 class CabiCLI < Thor
 
@@ -10,23 +10,29 @@ class CabiCLI < Thor
   method_options :mock => :boolean, :target => :string
   def init
     
-    target = options[:target] || CACHE_DIR
+    target = options[:target] || Cabi::CABI_CACHE_DIR
     FileUtils.mkdir( target )
 
     if options[:mock]
       f = File.expand_path( "../../data/cabi-cache.tar.gz", __FILE__ )
-      `tar -xf #{f} --strip-components=1 -C #{target}`
+      `tar -xf #{f} --strip-components=2 -C #{target}`
     end
 
+    puts " ** Cabi cache created in #{target}"
   end
 
   desc "clean", "Remove Cabi cache directory"
   method_options :force => :boolean  
   def clean
     if options[:force]
-      FileUtils.rm_rf( CACHE_DIR ) if options[:force]
+      begin
+        FileUtils.rm_rf( Cabi.cache_dir )
+        FileUtils.rm_rf( Cabi::CABI_CACHE_DIR)
+        puts " ** Cleaned cabi cache" 
+      rescue Exception => e
+      end
     else
-      puts "Not cleaning without --force" 
+      puts " ** Not cleaning cabi cache without --force" 
     end
   end
 

data/cabi.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name                  = 'cabi'
-  s.version               = '0.1.0'
+  s.version               = '0.1.1'
   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

@@ -8,6 +8,7 @@ end
 module Cabi
 
   DELIMITER       = ':'
+  BULK_SELECTOR   = '*'
   YAML_EXT        = '.yml'
   CABI_CACHE_ID   = '.cabi-cache'
   CABI_CACHE_DIR  = './cabi-cache'

data/lib/cache.rb

@@ -14,10 +14,8 @@ module Cabi
         dir = false
 
         Dir.foreach('.') do |item|
-          next if item == '.' or item == '..'
-          if File.directory?(item) and File.exists?( File.join(item, CABI_CACHE_ID) )
-            dir = item
-          end
+          next if item == '..' or !File.directory?(item)
+          dir = item if File.exists?( File.join(item, CABI_CACHE_ID) )
           break if dir
         end
 
@@ -28,7 +26,8 @@ module Cabi
 
   # Helpers for setting/getting cache dir.
   def self.cache_dir
-    @@cache_dir ||= Cache.user_cache_dir || CABI_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

data/lib/datafile.rb

@@ -3,9 +3,10 @@ module Cabi
   class DataFile
 
     def self.contents(id)
-      return File.read( self.file(id) )                 if self.file_exists?(id)
-      return File.read( self.yaml_file(id) )            if self.yaml_exists?(id)
-      return File.read( self.non_extension_file(id) )   if self.non_extension_file(id)
+      return self.bulk_selection(id)                        if self.bulk_selection?(id)
+      return File.read( self.file(id) )                     if self.file_exists?(id)
+      return YAML.load(File.read( self.yaml_file(id) ))     if self.yaml_exists?(id)
+      return File.read( self.non_extension_file(id) )       if self.non_extension_file(id)
       return self.sub_yaml(id)
     end
 
@@ -23,18 +24,6 @@ module Cabi
       File.open( file, 'w') {|f| f.write(content) } 
     end
 
-    def self.exists?(id)
-      self.file_exists?(id) or self.yaml_exists?(id)
-    end
-
-    def self.file_exists?(id)
-      File.exists?( self.file(id) )
-    end
-
-    def self.yaml_exists?(id)
-      File.exists?( self.yaml_file(id) )
-    end
-
     def self.file_yaml_or_non_extension_file(id)
       return self.file(id)                if self.file_exists?(id)
       return self.yaml_file(id)           if self.yaml_exists?(id)
@@ -43,19 +32,13 @@ module Cabi
     end
 
     def self.file(id)
-      id = id.split( DELIMITER )
-      id = [Cabi.cache_dir] + id
-      File.join( *id )
+      File.join( *self.id_array(id) )
     end
 
     def self.yaml_file(id)
       File.join( self.file(id) + YAML_EXT )
     end
 
-    def self.file_parent(id)
-      File.dirname( self.file(id) ) 
-    end
-
     def self.non_extension_file(id)
       base = id.split( DELIMITER ).last
 
@@ -68,9 +51,46 @@ module Cabi
       file
     end
 
+    def self.bulk_selection(id)
+      contents  = []
+
+      Dir.glob( File.join( *self.id_array(id) ) ).each do |f|
+        next if f == '.' or f == '..' or File.directory?(f)
+        contents << File.read(f) if File.exists?(f)
+      end
+
+      contents
+    end
+
+    def self.id_array(id)
+      id = id.split( DELIMITER )
+      [Cabi.cache_dir] + id
+    end
+
+    def self.exists?(id)
+      self.file_exists?(id) or self.yaml_exists?(id)
+    end
+
+    def self.file_exists?(id)
+      File.exists?( self.file(id) )
+    end
+
+    def self.yaml_exists?(id)
+      File.exists?( self.yaml_file(id) )
+    end
+
+    def self.file_parent(id)
+      File.dirname( self.file(id) ) 
+    end
+
+    def self.bulk_selection?(id)
+      self.id_array(id).join('').index /\*/
+    end
+
     def self.sub_yaml(id)
       id = id.split( DELIMITER )
       val = false
+
       id.each_with_index do |key, index|
         break if val
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cabi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Brian Gonzalez