acts_as_file 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5a692309dc92a0a6668370bdf0d1a750c41372dd
+  data.tar.gz: 7a8957cf252f0d825fad043b8a2235f9561ef97f
+SHA512:
+  metadata.gz: 6ddfc4ad98004d6ab638aa198abaca8d0b7aec385d4cd6f0a7af4148921b0dd22a9065cdb6b38e00ffd71566134463b7082cf18d4a97e285b89641ce007702be
+  data.tar.gz: dd63c176af3007665c0dec56812d108749ce3ab2bd042303c8786c47d6c79ab5999b75e99ab2d1fdf4763f749892dda7e3d546a5c6921951ad1214847bbca30b

data/.gitignore

@@ -0,0 +1,9 @@
+Gemfile.lock
+.bundle
+.yardoc
+*.rbc
+.rbx/
+doc/
+.DS_Store
+tags
+pkg/*

data/.travis.yml

@@ -0,0 +1,8 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - rbx
+  - jruby-19mode
+gemfile:
+  - Gemfile

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec
+gem 'coveralls', :require => false

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Naotoshi Seo
+
+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,55 @@
+# Acts as file
+
+`acts_as_file` makes your field act as a file.
+The content of the field is stored into a file on calling `#save` method, 
+and is loaded from the file on calling its accessor method. 
+
+[![Build Status](https://travis-ci.org/sonots/acts_as_file.svg)](https://travis-ci.org/sonots/acts_as_file)
+[![Coverage Status](https://coveralls.io/repos/sonots/acts_as_file/badge.png)](https://coveralls.io/r/sonots/acts_as_file)
+
+## Installation
+
+Add the following to your `Gemfile`:
+
+```ruby
+gem 'acts_as_file'
+```
+
+And then execute:
+
+```plain
+$ bundle
+```
+
+## Examples
+
+ActiveRecord is not required, but let me write an example for it.
+
+```ruby
+class Post < ActiveRecord::Base
+  include ActsAsFile
+  def filename
+    "posts/#{self.id}_body.txt"
+  end
+  acts_as_file :body => self.instance_method(:filename)
+end
+
+post = Post.new
+post.body = 'content'
+post.save      # save the content into the file of `#filename`
+loaded = Post.find(post.id)
+puts loaded.body # load the content from the file of `#filename`
+loaded.destroy   # remove the file
+```
+
+## 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
+
+## Copyright
+
+* Copyright (c) 2014 Naotoshi Seo. See [LICENSE](LICENSE) for details.

data/Rakefile

@@ -0,0 +1,16 @@
+# coding: utf-8
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |t|
+    t.rspec_opts = ["-c", "-f progress"] # '--format specdoc'
+      t.pattern = 'spec/**/*_spec.rb'
+end
+task :test => :spec
+task :default => :spec
+
+desc 'Open an irb session preloaded with the gem library'
+task :console do
+  sh 'irb -rubygems -I lib -r acts_as_file'
+end
+task :c => :console

data/acts_as_file.gemspec

@@ -0,0 +1,25 @@
+#!/usr/bin/env gem build
+# encoding: utf-8
+
+Gem::Specification.new do |s|
+  s.name          = "acts_as_file"
+  s.authors       = ["Naotoshi Seo"]
+  s.email         = ["sonots@gmail.com"]
+  s.homepage      = "https://github.com/sonots/acts_as_file"
+  s.summary       = "Make your field act as a file"
+  s.description   = "Make your field act as a file. Save the content to a file, and load the content from a file."
+  s.version       = '0.0.1'
+  s.date          = Time.now.strftime("%Y-%m-%d")
+
+  s.extra_rdoc_files = Dir["*.rdoc"]
+  s.files         = `git ls-files`.split($\)
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.rdoc_options  = ["--charset=UTF-8"]
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'pry-nav'
+end

data/lib/acts_as_file.rb

@@ -0,0 +1,74 @@
+module ActsAsFile
+  def self.included(klass)
+    klass.extend(ClassMethods)
+  end
+
+  # ToDo: rename if filename is changed
+  module ClassMethods
+    # acts_as_file :field => self.instance_method(:filename)
+    def acts_as_file(params = {})
+      self.class_eval do
+        unless method_defined?(:save_with_file)
+          define_method(:save_with_file) do |*args|
+            params.each do |field, filename_instance_method|
+              field_name = :"@#{field}"
+              filename = filename_instance_method.bind(self).call
+              content  = self.instance_variable_get(field_name)
+              File.open(filename, 'w') do |f|
+                f.flock(File::LOCK_EX) # inter-process locking
+                f.sync = true
+                f.write(content)
+                f.flush
+              end if filename and content
+            end
+            save_without_file(*args)
+          end
+          alias_method :save_without_file, :save
+          alias_method :save, :save_with_file
+
+          params.each do |field, filename_instance_method|
+            field_name = :"@#{field}"
+            define_method("#{field}=") do |content|
+              self.instance_variable_set(field_name, content)
+            end
+          end
+
+          params.each do |field, filename_instance_method|
+            field_name = :"@#{field}"
+            define_method(field) do |offset = nil, length = nil|
+              if offset || length
+                # does not cache in this way
+                filename = filename_instance_method.bind(self).call
+                return nil unless filename
+                return nil unless File.exist?(filename)
+                File.open(filename) do |file|
+                  file.seek(offset) if offset
+                  file.read(length)
+                end
+              else
+                content = self.instance_variable_get(field_name)
+                return content if content
+                # if (self.updated_at.nil? or File.mtime(filename) > self.updated_at)
+                filename = filename_instance_method.bind(self).call
+                return nil unless filename
+                return nil unless File.exist?(filename)
+                self.instance_variable_set(field_name, File.read(filename))
+              end
+            end
+          end
+
+          define_method(:destroy_with_file) do
+            params.each do |field, filename_instance_method|
+              field_name = :"@#{field}"
+              filename = filename_instance_method.bind(self).call
+              File.unlink(filename) if File.exist?(filename)
+            end
+            destroy_without_file
+          end
+          alias_method :destroy_without_file, :destroy
+          alias_method :destroy, :destroy_with_file
+        end
+      end
+    end
+  end
+end

data/spec/acts_as_file_spec.rb

@@ -0,0 +1,82 @@
+require_relative 'spec_helper'
+require 'acts_as_file'
+
+class Post
+  def initialize(params)
+    @name = params[:name]
+  end
+  attr_accessor :name
+  def save; end
+  def destroy; end
+  def self.delete_all; end
+end
+
+class TestPost < Post
+  include ActsAsFile
+  def filename
+    @filename ||= Tempfile.open(self.name) {|f| f.path }.tap {|name| File.unlink(name) }
+  end
+  acts_as_file :body => self.instance_method(:filename)
+end
+
+describe ActsAsFile do
+  let(:subject) { TestPost.new(name: 'name') }
+  after { TestPost.delete_all }
+  after { File.unlink(subject.filename) if File.exist?(subject.filename) }
+
+  context '#body=' do
+    it { expect { subject.body = 'aaaa' }.not_to raise_error }
+  end
+
+  context '#body' do
+    context 'get from instance variable' do
+      before { subject.body = 'aaaa' }
+      its(:body) { should == 'aaaa' }
+    end
+
+    context 'get from file' do
+      before { subject.body = nil }
+      before { File.write(subject.filename, 'aaaa') }
+      its(:body) { should == 'aaaa' }
+    end
+
+    context 'seek' do
+      before { File.write(subject.filename, 'abcd') }
+      it { subject.body(1, 2).should == 'bc' }
+    end
+
+    context 'file does not exit' do
+      before { File.unlink(subject.filename) if File.exist?(subject.filename) }
+      it { subject.body.should be_nil }
+      it { subject.body(1, 2).should be_nil }
+    end
+  end
+  
+  context '#save_with_file' do
+    context 'save if body exists' do
+      before { subject.body = 'aaaa' }
+      before { subject.save }
+      it { expect(File.read(subject.filename)).to eql('aaaa') }
+    end
+
+    context 'does not save if body does not exist' do
+      before { subject.body = nil }
+      before { subject.save }
+      it { expect(File.exist?(subject.filename)).to be_false }
+    end
+  end
+
+  context '#destroy_with_file' do
+    context 'delete if file exists' do
+      before { subject.save }
+      before { subject.destroy }
+      it { expect(File.exist?(subject.filename)).to be_false }
+    end
+
+    context 'fine even if file does not exist' do
+      before { subject.destroy }
+      it { expect(File.exist?(subject.filename)).to be_false }
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'rspec'
+require 'pry'
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+
+if ENV['TRAVIS']
+  require 'coveralls'
+  Coveralls.wear!
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_file
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Naotoshi Seo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-26 00:00:00.000000000 Z
+dependencies:
+- !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: 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: pry
+  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: pry-nav
+  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: Make your field act as a file. Save the content to a file, and load the
+  content from a file.
+email:
+- sonots@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- acts_as_file.gemspec
+- lib/acts_as_file.rb
+- spec/acts_as_file_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sonots/acts_as_file
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Make your field act as a file
+test_files:
+- spec/acts_as_file_spec.rb
+- spec/spec_helper.rb