cinch-storage 1.0.3 → 1.1.0

data/README.md

@@ -26,6 +26,10 @@ Or install it yourself as:
 
 ## Usage
 
+First, require it.
+
+    require 'cinch/storage'
+
 In your plugin you will need to spin up a Storage object as part of your init.
 
     def initialize(*args)
@@ -42,14 +46,10 @@ data collision.
       @storage.save
     end
 
-## This is Horrible Code!
-
-The module is very fragile at the moment as a result of being written in like 20 minutes
-or something as a stopgap.
+## Think this is terrible?
 
-However, since it doesn't look like Cinch::Storage will be happening very soon I will
-be going back through and adding tests and error handling and proper debugging and a
-little tighter integration with Cinch.
+I wouldn't disagree; this is my first time writing anyting remotely
+ORM-like. Please feel free to fork and submit pulls to increase sanity.
 
 ## Contributing
 

data/cinch-storage.gemspec

@@ -4,23 +4,25 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'cinch/storage/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "cinch-storage"
+  gem.name          = 'cinch-storage'
   gem.version       = Cinch::Storage::VERSION
-  gem.authors       = ["Brian Haberer"]
-  gem.email         = ["bhaberer@gmail.com"]
-  gem.description   = %q{Simle YAML backed Storage solution for Cinch plugins.}
-  gem.summary       = %q{Simle YAML backed Storage solution for Cinch plugins.}
-  gem.homepage      = "https://github.com/bhaberer/cinch-storage"
+  gem.authors       = ['Brian Haberer']
+  gem.email         = ['bhaberer@gmail.com']
+  gem.description   = %q{Simple YAML backed Storage solution for Cinch plugins.}
+  gem.summary       = %q{Data Storage for Cinch plugins.}
+  gem.homepage      = 'https://github.com/bhaberer/cinch-storage'
+  gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  gem.require_paths = ['lib']
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'coveralls'
   gem.add_development_dependency 'cinch-test'
 
+  gem.add_dependency    'cinch',        '~> 2.0.12'
   gem.add_dependency    'psych',        '~> 1.3.4'
 end

data/lib/cinch/storage.rb

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+require 'cinch/storage/version'
+require 'psych'
+
+module Cinch
+  # Addon for Cinch to allow for simple YAML storage of data
+  class Storage
+    attr_accessor :filename, :data
+
+    def initialize(file, init = {})
+      @filename = file
+      @data = Psych.load(File.open(@filename)) if File.exist?(@filename)
+      @data ||= init
+    end
+
+    def save
+      File.open(@filename, 'w') do |file|
+        Psych.dump(@data, file)
+      end
+    end
+
+    def synced_save(bot = @bot)
+      bot.synchronize(@filename) do
+        save
+      end
+    end
+  end
+end

data/lib/cinch/storage/version.rb

@@ -1,5 +1,7 @@
+# -*- encoding: utf-8 -*-
 module Cinch
-  module Storage
-    VERSION = "1.0.3"
+  # versioning info
+  class Storage
+    VERSION = '1.1.0'
   end
 end

data/spec/cinch-storage_spec.rb

@@ -1,43 +1,58 @@
 require 'spec_helper'
 
+Thing = Struct.new(:foo)
+
 class MyPlugin
   include Cinch::Plugin
 
   def initialize(*args)
     super
-    @storage = CinchStorage.new(config[:filename] || '/dev/null', [])
+    @storage = Cinch::Storage.new(config[:filename] || '/dev/null', [])
   end
 
-  match /store (.*)/
 
-  def execute(m, thing)
-    @storage.data << thing
+  match /store (.*)/,       method: :store_text
+  match /storething (.*)/,  method: :store_object
+
+  def store_text(m, text)
+    @storage.data << text
+    @storage.synced_save(@bot)
+  end
+
+  def store_object(m, text)
+    @storage.data << Thing.new(text)
     @storage.synced_save(@bot)
   end
 end
 
 
-describe CinchStorage do
+describe Cinch::Storage do
   include Cinch::Test
 
   before(:each) do
     @filename = '/tmp/storage_test.tmp'
     File.delete(@filename) if File.exist?(@filename)
-    @bot = make_bot(MyPlugin, { :filename => @filename })
+    @bot = make_bot(MyPlugin, { filename: @filename })
   end
 
   it 'should allow users to store information between bot runs' do
-    storage = CinchStorage.new(@filename, [])
+    storage = Cinch::Storage.new(@filename, [])
     storage.data << 'foo'
     storage.save
 
-    CinchStorage.new(@filename).data.
-      should include 'foo'
+    Cinch::Storage.new(@filename).data
+      .should include 'foo'
   end
 
   it 'should handle multiple bot threads attempting to write to the same file' do
-    10.times { |x| get_replies(make_message(@bot, "!store #{x}"))}
-    CinchStorage.new(@filename).data.length.
-      should == 10
+    10.times { |x| get_replies(make_message(@bot, "!store #{x}")) }
+    Cinch::Storage.new(@filename).data.length
+      .should == 10
+  end
+
+  it 'should write object data to the disk' do
+    get_replies(make_message(@bot, "!storething foobar"))
+    Cinch::Storage.new(@filename).data.first
+      .should == Thing.new('foobar')
   end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
 require 'coveralls'
 Coveralls.wear!
-require 'cinch-storage'
+require 'cinch/storage'
 require 'cinch/test'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cinch-storage
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-21 00:00:00.000000000 Z
+date: 2014-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -75,6 +75,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: cinch
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.12
 - !ruby/object:Gem::Dependency
   name: psych
   requirement: !ruby/object:Gem::Requirement
@@ -91,7 +107,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.3.4
-description: Simle YAML backed Storage solution for Cinch plugins.
+description: Simple YAML backed Storage solution for Cinch plugins.
 email:
 - bhaberer@gmail.com
 executables: []
@@ -105,12 +121,13 @@ files:
 - README.md
 - Rakefile
 - cinch-storage.gemspec
-- lib/cinch-storage.rb
+- lib/cinch/storage.rb
 - lib/cinch/storage/version.rb
 - spec/cinch-storage_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/bhaberer/cinch-storage
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -132,7 +149,7 @@ rubyforge_project:
 rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: Simle YAML backed Storage solution for Cinch plugins.
+summary: Data Storage for Cinch plugins.
 test_files:
 - spec/cinch-storage_spec.rb
 - spec/spec_helper.rb

data/lib/cinch-storage.rb

@@ -1,25 +0,0 @@
-require 'cinch/storage/version'
-require 'psych'
-
-class CinchStorage
-  attr_accessor :filename, :data
-
-  def initialize(file, init = Hash.new)
-    @filename = file
-    @data = Psych::load(File.open(@filename)) if File::exist?(@filename)
-    @data ||= init
-  end
-
-  def save
-    File.open(@filename, 'w') do |file|
-      Psych::dump(@data, file)
-    end
-  end
-
-  def synced_save(bot = @bot)
-    bot.synchronize(@filename) do
-      save
-    end
-  end
-end
-