cabi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 83fa2db5429675243c8acd14559770b0f65fd5f2
+  data.tar.gz: 5fb58665d172b8e4ba324fc316fea0fc50ec2436
+SHA512:
+  metadata.gz: b4d55e6e7c80c0c49565eeffe659866662adac9b4668faab05f11c73b315816af9902044cd313e6814b26069a3dea09727ccf85960cd2210c15104801af40b90
+  data.tar.gz: 34b74e174b4396ec9d7073bb501549e8a98e8c0dd7eca7d92882aad6d0bc2e26b592ae87abb3449485f9859a9c05bf8feabbb1122030e1fe4fd74c28d4c9dc9a

data/README.md

@@ -0,0 +1,67 @@
+# <img src="https://rawgithub.com/briangonzalez/cabi-gem/master/data/cabi.svg" width=30 style="margin-right: 10px"> Cabi
+
+A simple, flat-file datastore for Ruby.
+
+### Getting Started
+
+Cabi is a flat-file datastore where data is stored by directory stucture and accessed by colon-delimited strings. Here's how to get started:
+
+``` bash
+$ gem install cabi
+$ cabi init --mock
+```
+
+Then access your data like so:
+
+```bash
+$ irb
+  > require 'cabi'
+  > Cabi::Cache.read('pages:about:body')
+    => "<h1>Hello, Cabi!</h1>"
+```
+
+### Usage
+
+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
+            
+
+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
+```
+
+### Custom Cache 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`.
+
+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.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/bin/cabi

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+require "thor"
+require "fileutils"
+
+CACHE_DIR = 'cabi-cache'
+
+class CabiCLI < Thor
+
+  desc "init", "Initialize Cabi cache 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] || 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}`
+    end
+
+  end
+
+  desc "clean", "Remove Cabi cache directory"
+  method_options :force => :boolean  
+  def clean
+    if options[:force]
+      FileUtils.rm_rf( CACHE_DIR ) if options[:force]
+    else
+      puts "Not cleaning without --force" 
+    end
+  end
+
+end
+
+CabiCLI.start

data/cabi.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name                  = 'cabi'
+  s.version               = '0.1.0'
+  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."
+  s.authors               = ["Brian Gonzalez"]
+  s.email                 = 'me@briangonzalez.org'
+  s.homepage              = 'http://github.com/briangonzalez/cabi-gem'
+  s.license               = 'MIT'
+          
+  s.files                 = Dir['[A-Z]*', 'cabi.gemspec', '{bin,lib,conf,web,data}/**/*'] - ['Gemfile.lock']
+  s.executables           << 'cabi'
+
+  s.add_dependency        "thor", "~> 0.18", ">= 0.18.1"
+
+  s.required_ruby_version = '>= 1.9.3'
+end

data/data/cabi.svg

@@ -0,0 +1,21 @@
+<svg xmlns:x="http://ns.adobe.com/Extensibility/1.0/" xmlns:i="http://ns.adobe.com/AdobeIllustrator/10.0/" xmlns:graph="http://ns.adobe.com/Graphs/1.0/" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" id="Your_Icon" x="0px" y="0px" width="100px" height="100px" viewBox="0 0 100 100" enable-background="new 0 0 100 100" xml:space="preserve">
+<switch>
+	<foreignObject requiredExtensions="http://ns.adobe.com/AdobeIllustrator/10.0/" x="0" y="0" width="1" height="1">
+		</foreignObject>
+	<g i:extraneous="self">
+		<g>
+			<path d="M88.743,10.01c-0.054-5.781-7.651-9.701-7.982-9.869C80.576,0.048,80.373,0,80.166,0H19.71     c-0.208,0-0.411,0.048-0.595,0.141c-0.338,0.171-8.269,4.245-7.996,10.223c0.001,0.012,0.008,0.023,0.008,0.035     C11.047,10.753,11,11.12,11,11.496v76.741c0,2.899,2.522,5.259,5.622,5.259h4.202v1.245c0,2.899,2.523,5.259,5.623,5.259h0.71     c3.1,0,5.622-2.359,5.622-5.259v-1.245h34.441v1.245c0,2.899,2.522,5.259,5.622,5.259h0.71c3.1,0,5.623-2.359,5.623-5.259v-1.245     h4.202c3.099,0,5.622-2.359,5.622-5.259V11.496C89,10.977,88.895,10.485,88.743,10.01z M86.275,30.158H13.725V11.496     c0-1.403,1.301-2.545,2.897-2.545h66.756c1.598,0,2.897,1.142,2.897,2.545V30.158z M13.725,31.803h72.551v21.769H13.725V31.803z      M20.035,2.616h59.807c1.205,0.652,3.23,2.016,4.652,3.728c-0.361-0.068-0.734-0.105-1.116-0.105H16.622     c-0.435,0-0.854,0.058-1.261,0.145C16.784,4.658,18.822,3.274,20.035,2.616z M30.055,94.741c0,1.403-1.301,2.546-2.897,2.546     h-0.71c-1.598,0-2.898-1.143-2.898-2.546v-1.245h6.506V94.741z M76.451,94.741c0,1.403-1.301,2.546-2.898,2.546h-0.71     c-1.597,0-2.897-1.143-2.897-2.546v-1.245h6.506V94.741z M83.378,90.783H16.622c-1.597,0-2.897-1.143-2.897-2.546V55.215h72.551     v33.022C86.275,89.641,84.976,90.783,83.378,90.783z"/>
+			<path d="M60.804,20.102c0,0.675-0.677,1.244-1.478,1.244H40.508c-0.802,0-1.479-0.569-1.479-1.244v-4.228h-2.725v4.228     c0,2.181,1.886,3.956,4.203,3.956h18.818c2.316,0,4.202-1.775,4.202-3.956v-4.228h-2.725V20.102z"/>
+			<path d="M26.328,34.064H16.162c-0.455,0-0.824,0.367-0.824,0.82v3.602c0,0.453,0.369,0.821,0.824,0.821s0.825-0.368,0.825-0.821     v-2.779h9.341c0.455,0,0.826-0.369,0.826-0.822S26.783,34.064,26.328,34.064z"/>
+			<path d="M16.162,41.133c-0.455,0-0.824,0.368-0.824,0.82v3.254c0,0.453,0.369,0.821,0.824,0.821s0.825-0.368,0.825-0.821v-3.254     C16.987,41.501,16.617,41.133,16.162,41.133z"/>
+			<path d="M60.43,39.273v4.228c0,0.675-0.678,1.243-1.48,1.243H40.131c-0.801,0-1.479-0.568-1.479-1.243v-4.228h-2.724v4.228     c0,2.181,1.886,3.956,4.202,3.956h18.818c2.318,0,4.205-1.775,4.205-3.956v-4.228H60.43z"/>
+			<path d="M60.43,65.609c0,0.675-0.678,1.245-1.48,1.245H40.131c-0.801,0-1.479-0.57-1.479-1.245v-4.228h-2.724v4.228     c0,2.182,1.886,3.957,4.202,3.957h18.818c2.318,0,4.205-1.775,4.205-3.957v-4.228H60.43V65.609z"/>
+			<path d="M16.622,21.19c-0.455,0-0.825,0.368-0.825,0.821v2.6c0,0.454,0.37,0.822,0.825,0.822s0.825-0.368,0.825-0.822v-2.6     C17.447,21.558,17.077,21.19,16.622,21.19z"/>
+			<path d="M28.698,10.675H16.622c-0.455,0-0.825,0.368-0.825,0.821v5.963c0,0.454,0.37,0.822,0.825,0.822s0.825-0.368,0.825-0.822     v-5.141h11.251c0.455,0,0.825-0.368,0.825-0.822C29.523,11.043,29.153,10.675,28.698,10.675z"/>
+			<path d="M28.698,57.475H16.622c-0.455,0-0.825,0.369-0.825,0.822v4.252c0,0.453,0.37,0.82,0.825,0.82s0.825-0.367,0.825-0.82     v-3.432h11.251c0.455,0,0.825-0.367,0.825-0.82S29.153,57.475,28.698,57.475z"/>
+			<path d="M16.622,65.628c-0.455,0-0.825,0.368-0.825,0.822v5.853c0,0.453,0.37,0.821,0.825,0.821s0.825-0.368,0.825-0.821V66.45     C17.447,65.996,17.077,65.628,16.622,65.628z"/>
+			<path d="M16.622,77.12c-0.455,0-0.825,0.368-0.825,0.822v3.034c0,0.452,0.37,0.82,0.825,0.82s0.825-0.368,0.825-0.82v-3.034     C17.447,77.488,17.077,77.12,16.622,77.12z"/>
+		</g>
+	</g>
+</switch>
+</svg>

data/lib/cabi.rb

@@ -0,0 +1,23 @@
+
+require 'yaml'
+
+Dir.glob( File.expand_path( '..', __FILE__) + '/*.rb' ).each do |f|
+  require File.join( File.expand_path( '..', f), File.basename(f, File.extname(f)) )
+end 
+
+module Cabi
+
+  DELIMITER       = ':'
+  YAML_EXT        = '.yml'
+  CABI_CACHE_ID   = '.cabi-cache'
+  CABI_CACHE_DIR  = './cabi-cache'
+
+  def self.read(id)
+    Cache.read(id)
+  end
+
+  def self.write(id, content)
+    Cache.write(id, content)
+  end
+
+end

data/lib/cache.rb

@@ -0,0 +1,40 @@
+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 item == '..'
+          if File.directory?(item) and File.exists?( File.join(item, CABI_CACHE_ID) )
+            dir = item
+          end
+          break if dir
+        end
+
+        dir
+      end
+
+  end
+
+  # Helpers for setting/getting cache dir.
+  def self.cache_dir
+    @@cache_dir ||= Cache.user_cache_dir || CABI_CACHE_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

data/lib/datafile.rb

@@ -0,0 +1,92 @@
+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.sub_yaml(id)
+    end
+
+    def self.write(id, content)
+      file      = self.file_yaml_or_non_extension_file(id)
+      new_file  = self.file(id)
+
+      if not file
+        parent    = File.expand_path( '..', new_file )
+        FileUtils.mkdir_p(parent)     unless File.exists?(parent)
+        FileUtils.touch(new_file)     unless File.exists?(new_file)
+        file = new_file
+      end
+
+      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)
+      return self.non_extension_file(id)  if self.non_extension_file(id)
+      nil
+    end
+
+    def self.file(id)
+      id = id.split( DELIMITER )
+      id = [Cabi.cache_dir] + id
+      File.join( *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
+
+      file = false
+      Dir.glob( self.file_parent(id) + '/*' ).each do |f|
+        file = File.join(f) if File.basename(f, File.extname(f)) == base
+        break if file
+      end
+
+      file
+    end
+
+    def self.sub_yaml(id)
+      id = id.split( DELIMITER )
+      val = false
+      id.each_with_index do |key, index|
+        break if val
+
+        a                 =  [Cabi.cache_dir] + id[0..index] 
+        a[ a.length - 1 ] =  a[a.length - 1 ] + YAML_EXT
+        f = File.join( *a )
+
+        if File.exists? f
+          data = YAML.load( File.read(f) )
+          val = data.access( id[index+1..-1].join(DELIMITER) )
+        end
+      end
+
+      val
+    end
+
+  end
+
+end

data/lib/hash.rb

@@ -0,0 +1,19 @@
+
+class Hash
+  
+  def access(path)
+    val = false
+
+    path.split( Cabi::DELIMITER ).each do |p|
+      if p.to_i.to_s == p
+        val = self[p.to_i]
+      else
+        val = self[p.to_s] || self[p.to_sym]
+      end
+      break unless val
+    end
+
+    val
+  end
+
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: cabi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brian Gonzalez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.18'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.18'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+description: Cabi is a flat-file datastore where data is stored by directory stucture
+  and accessed by colon-delimited strings.
+email: me@briangonzalez.org
+executables:
+- cabi
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- README.md
+- cabi.gemspec
+- bin/cabi
+- lib/cabi.rb
+- lib/cache.rb
+- lib/datafile.rb
+- lib/hash.rb
+- data/cabi-cache.tar.gz
+- data/cabi.svg
+homepage: http://github.com/briangonzalez/cabi-gem
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A simple, flat-file datastore for Ruby.
+test_files: []