soup 0.9.13 → 1.0.0

data/Rakefile

@@ -21,7 +21,7 @@ spec = Gem::Specification.new do |s|
   
   # Change these as appropriate
   s.name              = "soup"
-  s.version           = "0.9.13"
+  s.version           = "1.0.0"
   s.summary           = "A super-simple data store"
   s.author            = "James Adam"
   s.email             = "james@lazyatom.com"

data/lib/soup.rb

@@ -32,7 +32,7 @@ class Soup
 
   # Get the soup ready!
   def initialize(backend=nil)
-    @backend = backend || Soup::Backends::YAMLBackend.new
+    @backend = backend || Soup::Backends::FileBackend.new
     @backend.prepare
   end
 

data/lib/soup/backends.rb

@@ -10,5 +10,6 @@ class Soup
     autoload :YAMLBackend, 'soup/backends/yaml_backend'
     autoload :MultiSoup, 'soup/backends/multi_soup'
     autoload :ReadOnly, 'soup/backends/read_only'
+    autoload :FileBackend, 'soup/backends/file_backend'
   end
 end

data/lib/soup/backends/file_backend.rb

@@ -0,0 +1,66 @@
+class Soup
+  module Backends
+    class FileBackend < Base
+      def initialize(path="soup")
+        @base_path = path
+      end
+
+      def prepare
+        FileUtils.mkdir_p(@base_path)
+      end
+
+      def names
+        Dir[path_for("*")].map { |s| File.basename(s, ".snip") }
+      end
+
+      def load_snip(name)
+        path = path_for(name)
+        if File.exist?(path)
+          file = File.new(path)
+          data = file.read
+          default_attributes = {:name => name, :updated_at => file.mtime}
+          if attribute_start = data.index("\n:")
+            content = data[0, attribute_start].strip
+            attributes = default_attributes.merge(YAML.load(data[attribute_start, data.length]).merge(:content => content))
+          else
+            attributes = default_attributes.merge(:content => data)
+          end
+          Snip.new(attributes, self)
+        else
+          nil
+        end
+      end
+
+      def save_snip(attributes)
+        File.open(path_for(attributes[:name]), 'w') do |f|
+          attributes_without_content = attributes.dup
+          f.write attributes_without_content.delete(:content)
+          f.write attributes_without_content.to_yaml.gsub(/^---\s/, "\n") if attributes_without_content.any?
+        end
+        Snip.new(attributes, self)
+      end
+
+      def destroy(name)
+        path = path_for(name)
+        if File.exist?(path)
+          File.delete(path)
+          true
+        else
+          nil
+        end
+      end
+
+      private
+
+      def path_for(name)
+        File.join(@base_path, name + ".snip")
+      end
+
+      def all_snips
+        Dir[path_for("*")].map do |key|
+          load_snip(File.basename(key, ".snip"))
+        end
+      end
+    end
+  end
+end

data/test/file_backend_test.rb

@@ -0,0 +1,59 @@
+require "test_helper"
+require "ftools"
+
+class FileBackendTest < Test::Unit::TestCase
+  context "The file-based backend" do
+    setup do
+      @base_path = File.join(File.dirname(__FILE__), *%w[.. tmp soup])
+      @soup = Soup.new(Soup::Backends::FileBackend.new(@base_path))
+    end
+
+    should "parse attributes from lines starting with colon" do
+      write_snip "snip", %{
+Here is the content
+of the snip
+
+:name: thing
+:render_as: Markdown
+:multi_line_attribute: |
+  stuff
+  things
+:blah: yes
+      }
+
+      snip = @soup["snip"]
+      assert_equal "Here is the content\nof the snip", snip.content
+      assert_equal "thing", snip.name
+    end
+
+    should "write a snip in the simple format" do
+      @soup << {:content => "Here is the content", :name => "dave"}
+
+      assert_equal %{Here is the content\n\n:name: dave\n}, File.read(path_for("dave"))
+    end
+
+    should "take name from filename if not supplied" do
+      write_snip "blahface", "The snip content"
+      assert_equal "blahface", @soup["blahface"].name
+    end
+
+    should "take updated_at from file timestamps if not supplied" do
+      write_snip "snip", "whatever"
+      updated = Time.parse("2010-11-04 14:56")
+      File.utime(updated, updated, path_for("snip"))
+
+      snip = @soup["snip"]
+      assert_equal updated, snip.updated_at
+    end
+  end
+
+  private
+
+  def path_for(name)
+    File.join(@base_path, name + ".snip")
+  end
+
+  def write_snip(name, content)
+    File.open(path_for(name), "w") { |f| f.write content.strip }
+  end
+end

data/test/multi_soup_backend_test.rb

@@ -5,7 +5,7 @@ class MultiSoupBackendTest < Test::Unit::TestCase
     setup do
       @base_path = File.join(File.dirname(__FILE__), *%w[.. tmp soup])
       @basic_soup_backend_one = Soup::Backends::YAMLBackend.new(File.join(@base_path, "soup_one"))
-      @basic_soup_backend_two = Soup::Backends::YAMLBackend.new(File.join(@base_path, "soup_two"))
+      @basic_soup_backend_two = Soup::Backends::FileBackend.new(File.join(@base_path, "soup_two"))
       @soup_one = Soup.new(@basic_soup_backend_one)
       @soup_two = Soup.new(@basic_soup_backend_two)
       multi_soup_backend = Soup::Backends::MultiSoup.new(@basic_soup_backend_one, @basic_soup_backend_two)

data/test/soup_test.rb

@@ -6,6 +6,7 @@ class SoupTest < Test::Unit::TestCase
     base_path = File.join(File.dirname(__FILE__), *%w[.. tmp soup])
     backends = [
       yaml_backend = Soup::Backends::YAMLBackend.new(base_path),
+      file_backend = Soup::Backends::FileBackend.new(base_path),
       Soup::Backends::MultiSoup.new(yaml_backend)
     ]
     backends.each do |backend|

metadata

@@ -3,10 +3,10 @@ name: soup
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
+  - 1
   - 0
-  - 9
-  - 13
-  version: 0.9.13
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
 - James Adam
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-14 00:00:00 +01:00
+date: 2010-08-08 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,10 +41,12 @@ files:
 - Manifest
 - Rakefile
 - README
+- test/file_backend_test.rb
 - test/multi_soup_backend_test.rb
 - test/soup_test.rb
 - test/test_helper.rb
 - lib/soup/backends/base.rb
+- lib/soup/backends/file_backend.rb
 - lib/soup/backends/multi_soup.rb
 - lib/soup/backends/read_only.rb
 - lib/soup/backends/yaml_backend.rb