file_marshal 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2e27933be6ab40fee02ab09b35b2b83db25c593c
+  data.tar.gz: 2f8c3403ab7b31073a571ed14b1697abfab22595
+SHA512:
+  metadata.gz: b810e76f72917eb4ef28a9494e8ff274a6d1dd0342dc66aebd8d8e6db2ddcc7b9735cb992bd9d9db7acc758237bf77a98b678f6c4f6d7309bca749e91fe25ebc
+  data.tar.gz: 9c03f99ee34250ce8eecdd300867a24738ebf702f3fbc952622585153aff19c516ba29a4ead12198536e5e6676474d9155308be8c3fe830f31093e9cdfa47e4c

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+**/*.DS_Store
+spec/support/new_commodore.jpg

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rvmrc

@@ -0,0 +1,6 @@
+rvm_install_on_use_flag=1
+rvm_trust_rvmrcs_flag=1
+rvm_gemset_create_on_use_flag=1
+
+rvm use 2.0.0@file_marshal --create
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in file_marshal.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 socialchorus
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# FileMarshal
+
+FileMarshal has the goal of providing easy ways to serialize files to send across the wire. Marshal is unable to dump files because they are IO and potentially limitless. In practice, files are finite and we want to move them around. Enjoy!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'file_marshal'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install file_marshal
+
+## Usage
+
+FileMarshal uses the class methods `FileMarshal.dump(file)` and `FileMarshal.load(string)` to pack and unpack files. As with other types of serialization including YAML, JSON, and Marshal, the files are packaged as a string. 
+
+In order to serialize a file into a string you could use this code:
+
+    file = File.new(my_path, 'r')
+    serialized_file = FileMarshal.dump(file) # => a string of data that can be read again
+
+When you are ready to read these serializations back into a file, use the load method:
+
+    tempfile = FileMarshal.load(serialized_file)
+
+If you are looking for a file with a specific path, rather than a tempfile, pass the path in as a second argument:
+
+    file = FileMarshal.load(serialized_file, new_path)
+
+In reality, this string is JSON, and under the covers there are classes that work with hashes to pass the data around. In many instances you will want to use these underlying classes instead of the `.dump` and `.load` methods:
+
+    hash = FileMarshal::Dumper.new(file).to_hash
+
+    tempfile = FileMarshal::Loader.new(hash).tempfile
+    file = FileMarshal::Loader.new(hash).to_file(my_great_path)
+
+Everything is very small objects, which should make other usages as easy as inspecting the code.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/file_marshal.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'file_marshal/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "file_marshal"
+  spec.version       = FileMarshal::VERSION
+  spec.authors       = ["socialchorus", "Matt Mills", "Kane Baccigalupi"]
+  spec.email         = ["developers@socialchorus.com"]
+  spec.description   = %q{Serializes files to hashes of strings for serialization over various protocols}
+  spec.summary       = %q{Serializes files to hashes of strings for serialization over various protocols}
+  spec.homepage      = "http://github.com/socialchorus/file_marshal"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'superbolt'
+end

data/lib/file_marshal.rb

@@ -0,0 +1,15 @@
+require 'tempfile'
+require 'json'
+require 'time'
+
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/hash'
+
+require "file_marshal/version"
+require "file_marshal/dumper"
+require "file_marshal/loader"
+require "file_marshal/file_attributes"
+require "file_marshal/writer"
+require "file_marshal/writer/temp"
+require "file_marshal/writer/file"
+require "file_marshal/facade"

data/lib/file_marshal/dumper.rb

@@ -0,0 +1,22 @@
+module FileMarshal
+  class Dumper
+    attr_reader :file
+
+    def initialize(file)
+      @file = file
+    end
+
+    def to_hash
+      { 
+        updated_at: file.mtime,
+        name: File.basename(file.path),
+        content: content
+      }
+    end
+
+    def content
+      file.rewind
+      file.read
+    end
+  end
+end

data/lib/file_marshal/facade.rb

@@ -0,0 +1,12 @@
+module FileMarshal
+  def self.dump(file)
+    hash = FileMarshal::Dumper.new(file).to_hash
+    hash.to_json
+  end
+
+  def self.load(string, path=nil)
+    hash = JSON.parse(string)
+    loader = FileMarshal::Loader.new(hash)
+    path ? loader.to_file(path) : loader.tempfile
+  end
+end

data/lib/file_marshal/file_attributes.rb

@@ -0,0 +1,4 @@
+module FileMarshal
+  class FileAttributes < Struct.new(:name, :content, :updated_at)
+  end
+end

data/lib/file_marshal/loader.rb

@@ -0,0 +1,23 @@
+module FileMarshal
+  class Loader
+    attr_reader :attributes, :file
+
+    def initialize(opts)
+      opts.symbolize_keys!
+      @attributes = FileAttributes.new(
+        opts[:name], opts[:content], opts[:updated_at]
+      )
+    end
+
+    delegate :name,
+        to: :attributes
+
+    def tempfile
+      Writer::Temp.new(attributes).build
+    end
+
+    def to_file(path)
+      Writer::File.new(attributes, path).build
+    end
+  end
+end

data/lib/file_marshal/version.rb

@@ -0,0 +1,3 @@
+module FileMarshal
+  VERSION = "0.0.1"
+end

data/lib/file_marshal/writer.rb

@@ -0,0 +1,36 @@
+module FileMarshal
+  class Writer
+    attr_reader :attributes, :file
+
+    def initialize(attributes)
+      @attributes = attributes
+    end
+
+    delegate :name, :content, :updated_at,
+      to: :attributes
+
+    def build
+      write
+      set_time
+      prepare
+    end  
+
+    def file
+      raise NotImplementedError
+    end
+
+    def write
+      file.write(content)
+      file
+    end
+
+    def set_time
+      ::File.utime(file.atime, Time.parse(updated_at), file.path)
+    end
+
+    def prepare
+      file.rewind
+      file
+    end
+  end
+end

data/lib/file_marshal/writer/file.rb

@@ -0,0 +1,16 @@
+module FileMarshal
+  class Writer
+    class File < Writer
+      attr_reader :path
+
+      def initialize(attributes, path)
+        @attributes = attributes
+        @path = path
+      end
+
+      def file
+        @file ||= ::File.new(path, "w+")
+      end
+    end
+  end
+end

data/lib/file_marshal/writer/temp.rb

@@ -0,0 +1,9 @@
+module FileMarshal
+  class Writer
+    class Temp < Writer
+      def file
+        @file ||= Tempfile.new(name)
+      end
+    end
+  end
+end

data/spec/dumper_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe FileMarshal::Dumper do
+  let(:file) { File.open(File.dirname(__FILE__) + '/support/commodore.jpg') }
+  let(:dumper) { FileMarshal::Dumper.new(file) }
+
+  describe "#to_hash" do
+    let(:attributes) { dumper.to_hash }
+
+    it "gets the file name" do
+      attributes[:name].should == "commodore.jpg"
+    end
+
+    it "gets the updated at time for the file" do
+      attributes[:updated_at].should == file.mtime
+    end
+
+    it "takes a file and turns it into a string" do
+      content = file.read
+      attributes[:content].should == content
+    end
+  end
+end

data/spec/file_marshal_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe FileMarshal do
+  let(:path) { File.dirname(__FILE__) + '/support/commodore.jpg' }
+  let(:hash) { {hello: 'world'} }
+
+  describe '.dump' do
+    let(:dumper) { double('dumper', to_hash: hash) }
+    
+    let(:file) { File.open(path) }
+
+    it "converts to a string using the Dumper" do
+      FileMarshal::Dumper.should_receive(:new).with(file).and_return(dumper)
+
+      FileMarshal.dump(file).should == hash.to_json
+    end
+  end
+
+  describe '.load' do
+    let(:loader) { double("writer", to_file: "file", tempfile: 'tempfile') }
+    
+    context 'when a path is provided' do
+      it "returns a file with the path" do
+        FileMarshal::Loader.should_receive(:new)
+          .with({'hello' => 'world'})
+          .and_return(loader)
+        loader.should_receive(:to_file).with(path).and_return('my file')
+
+        FileMarshal.load(hash.to_json, path).should == 'my file'
+      end
+    end 
+
+    context 'when a path is not provided' do
+      it "returns a tempfile" do
+        FileMarshal::Loader.should_receive(:new)
+          .with({'hello' => 'world'})
+          .and_return(loader)
+        loader.should_receive(:tempfile).and_return('tempfile')
+
+        FileMarshal.load(hash.to_json).should == 'tempfile'
+      end
+    end
+  end
+end

data/spec/loader_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe FileMarshal::Loader do
+  let(:file) { File.open(File.dirname(__FILE__) + '/support/commodore.jpg') }
+  let(:attributes) { JSON.parse(FileMarshal::Dumper.new(file).to_hash.to_json) }
+  let(:loader) { FileMarshal::Loader.new(attributes) }
+
+  describe '#tempfile' do
+    let(:new_file) { loader.tempfile }
+
+    it "is a tempfile" do
+      new_file.should be_a Tempfile
+    end
+
+    it "should have the right mtime" do
+      new_file.mtime.should == attributes[:updated_at]
+    end
+
+    it "should have the right content" do
+      new_file.read.should == attributes[:content]
+    end
+  end
+
+  describe '#file' do
+    let(:new_file) { loader.to_file(new_commodore_path) }
+    let(:new_commodore_path) { File.dirname(__FILE__) + '/support/new_commodore.jpg' }
+
+    before do
+      File.delete(new_commodore_path) if File.exist?(new_commodore_path)
+    end
+
+    it "creates the file" do
+      loader.to_file(new_commodore_path)
+      File.exist?(new_commodore_path).should be_true
+    end
+
+    it "should have the right mtime" do
+      new_file.mtime.should == attributes[:updated_at]
+    end
+
+    it "should have the right content" do
+      new_file.read.should == attributes[:content]
+    end
+  end
+
+  describe '#name' do
+    it "gets it from the attributes passed in" do
+      loader.name.should == 'commodore.jpg'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+here = File.dirname(__FILE__)
+require "#{here}/../lib/file_marshal"
+Dir["#{here}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: file_marshal
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- socialchorus
+- Matt Mills
+- Kane Baccigalupi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: superbolt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Serializes files to hashes of strings for serialization over various
+  protocols
+email:
+- developers@socialchorus.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- file_marshal.gemspec
+- lib/file_marshal.rb
+- lib/file_marshal/dumper.rb
+- lib/file_marshal/facade.rb
+- lib/file_marshal/file_attributes.rb
+- lib/file_marshal/loader.rb
+- lib/file_marshal/version.rb
+- lib/file_marshal/writer.rb
+- lib/file_marshal/writer/file.rb
+- lib/file_marshal/writer/temp.rb
+- spec/dumper_spec.rb
+- spec/file_marshal_spec.rb
+- spec/loader_spec.rb
+- spec/spec_helper.rb
+- spec/support/commodore.jpg
+homepage: http://github.com/socialchorus/file_marshal
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+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: Serializes files to hashes of strings for serialization over various protocols
+test_files:
+- spec/dumper_spec.rb
+- spec/file_marshal_spec.rb
+- spec/loader_spec.rb
+- spec/spec_helper.rb
+- spec/support/commodore.jpg