acts_as_git 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dc3679a8508f062ffe650d55db72d791a36c0127
+  data.tar.gz: 09facb40c19acafa08e3a37b0ae12000f9850232
+SHA512:
+  metadata.gz: ef96fa5c6ec73f818a3bec7e89d6ff58871609b4e2e06e21ed4f1bdb363403d233e1e9f5ad4a04fddea793a4eb5379746ef4030d784e2d886c0edfbd14b86399
+  data.tar.gz: 48869fd42be00dddfdd0f4c5e325e1c2c1487a4b6be12a5c443ba29953bb3d9ed17e2df1c9a9c1bd29a0a8be03c4f105b424b3f3fe7afd227ed55c30128e6191

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
+  - rbx-2
+  - jruby-19mode
+gemfile:
+  - Gemfile

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## 0.0.2 (2014/05/28)
+
+Enhancements:
+
+* Create the directory if not exist on #save
+* #save and #destory methods are not required in prior
+
+## 0.0.1
+
+First version

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,49 @@
+## Examples
+
+ActiveRecord is not required, but let me write an example for it.
+
+```ruby
+ActsAsGit.configure do |config|
+  config.email = 'test@test.com'
+  config.username = 'testuser'
+end
+
+class Post < ActiveRecord::Base
+  include ActsAsGit
+  def self.repodir
+    "posts"
+  end
+
+  def filename
+    "#{self.id}_body.txt"
+  end
+  acts_as_git :body => self.instance_method(:filename)
+end
+
+# store
+post = Post.new # create the directory `self.repodir` if not exist, and init repo.
+post.body = 'content'
+post.save # save the content into the file of `#filename`
+post.get_commit
+  => COMMIT_HASH_HOGE
+
+# load
+post = Post.first
+puts post.body
+  => 'content'
+
+# history
+post.body = 'content2'
+post.is_changed?
+  => true
+post.save
+post.is_changed?
+  => false
+post.get_commit
+  => COMMIT_HASH_FUGA
+puts post.body
+  => 'content2'
+post.checkout(COMMIT_HASH_HOGE)
+puts post.body
+  => 'content'
+```

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_git'
+end
+task :c => :console

data/acts_as_git.gemspec

@@ -0,0 +1,28 @@
+#!/usr/bin/env gem build
+# encoding: utf-8
+
+Gem::Specification.new do |s|
+  s.name          = "acts_as_git"
+  s.authors       = ["Satoshi Amemiya", "Naotoshi Seo"]
+  s.email         = ["rail.sky@gmail.com", "sonots@gmail.com"]
+  s.homepage      = "https://github.com/rail44/acts_as_git"
+  s.summary       = "Make your field act as a git repo"
+  s.description   = "Make your field act as a git repo. Save the content to a file, and load the content from a file."
+  s.version       = '0.1.0'
+  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_runtime_dependency 'rugged'
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rspec-its'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'pry-nav'
+end

data/lib/acts_as_git.rb

@@ -0,0 +1,164 @@
+require 'fileutils'
+require 'rugged'
+
+module ActsAsGit
+  def self.included(klass)
+    klass.extend(ClassMethods)
+  end
+
+  def self.configure
+    ClassMethods.module_eval do
+      yield self
+    end
+  end
+
+  # ToDo: rename if filename is changed
+  module ClassMethods
+    def self.email=(email)
+      @@email = email
+    end
+
+    def self.username=(username)
+      @@username = username
+    end
+
+    def get_option(index)
+      option = {}
+      option[:author] = { :email => @@email, :name => @@username, :time => Time.now }
+      option[:committer] = { :email => @@email, :name => @@username, :time => Time.now }
+      option[:parents] = @@repo.empty? ? [] : [ @@repo.head.target ].compact
+      option[:tree] = index.write_tree(@@repo)
+      option[:update_ref] = 'HEAD'
+      option
+    end
+
+    # acts_as_git :field => self.instance_method(:filename)
+    def acts_as_git(params = {})
+      self.class_eval do
+        unless method_defined?(:save_with_file)
+          def self.path(filename)
+            File.join(repodir, filename)
+          end
+
+          def commit
+            if @commit
+              @commit
+            else
+             (@@repo.empty?)? nil: @@repo.head.target
+            end
+          end
+
+          def is_changed?
+            (@is_changed)? true: false
+          end
+
+          def get_commit
+            (commit)? commit.oid: nil
+          end
+
+          define_method :checkout do |commit|
+            @commit = (commit)? @@repo.lookup(commit): nil
+            @is_changed = false
+            params.each do |field, filename_instance_method|
+              field = nil
+            end
+            self
+          end
+
+          repodir = self.repodir
+          FileUtils.mkdir_p(repodir)
+          begin
+            @@repo = Rugged::Repository.new(repodir)
+          rescue
+            Rugged::Repository.init_at(repodir)
+            @@repo = Rugged::Repository.new(repodir)
+          end
+
+          define_method(:save_with_file) do |*args|
+            params.each do |field, filename_instance_method|
+              field_name = :"@#{field}"
+              repodir = self.class.repodir
+              filename = filename_instance_method.bind(self).call
+              content  = instance_variable_get(field_name)
+              if repodir and filename and content
+                oid = @@repo.write(content, :blob)
+                index = @@repo.index
+                path = self.class.path(filename)
+                action = File.exists?(path)? 'Update': 'Create'
+                FileUtils.mkdir_p(File.dirname(path))
+                File.open(path, 'w') do |f|
+                  f.write(content)
+                end
+                index.add(path: filename, oid: oid, mode: 0100644)
+                option = self.class.get_option(index)
+                option[:message] = "#{action} #{filename} for field #{field_name} of #{self.class.name}"
+                Rugged::Commit.create(@@repo, option)
+                @commit = @@repo.head.target
+                @is_changed = false
+                index.read_tree(@commit.tree)
+                index.write
+                instance_variable_set(field_name, nil)
+              end
+            end
+            save_without_file(*args)
+          end
+
+          define_method(:save) {|*args| } unless method_defined?(:save)
+          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|
+              instance_variable_set(field_name, content)
+              @is_changed = true
+            end
+          end
+
+          params.each do |field, filename_instance_method|
+            field_name = :"@#{field}"
+            define_method(field) do |offset = nil, length = nil|
+              if @is_changed
+                return instance_variable_get(field_name)
+              end
+              filename = filename_instance_method.bind(self).call
+              return nil unless repodir
+              return nil unless filename
+              return nil if @@repo.empty?
+              return nil unless fileob = commit.tree[filename]
+              oid = fileob[:oid]
+              file = StringIO.new(@@repo.lookup(oid).content)
+              file.seek(offset) if offset
+              file.read(length)
+            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
+              index = @@repo.index
+              path = self.class.path(filename)
+              File.unlink(path) if File.exists?(path)
+              begin
+                index.remove(filename)
+                option = self.class.get_option(index)
+                option[:message] = "Remove #{filename} for field #{field_name} of #{self.class.name}"
+                Rugged::Commit.create(@@repo, option)
+                @commit = @@repo.head.target
+                @is_changed = false
+                index.read_tree(@commit.tree)
+                index.write
+              rescue Rugged::IndexError => e
+              end
+            end
+            destroy_without_file
+          end
+          define_method(:destroy) {} unless method_defined?(:destroy)
+          alias_method :destroy_without_file, :destroy
+          alias_method :destroy, :destroy_with_file
+        end
+      end
+    end
+  end
+end

data/spec/acts_as_git_spec.rb

@@ -0,0 +1,80 @@
+require_relative 'spec_helper'
+require_relative 'model'
+
+describe ActsAsGit do
+  let(:subject) { TestPost.new }
+  after do
+    File.unlink(TestPost.path subject.filename) if File.exist?(TestPost.path subject.filename)
+  end
+
+  after(:context) do
+    FileUtils.rm_rf(File.join(TestPost.repodir, '.git')) if Dir.exist?(File.join(TestPost.repodir, '.git'))
+  end
+
+  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 = 'aaaa' }
+      before { subject.save }
+      its(:body) { should == 'aaaa' }
+    end
+
+    context 'seek' do
+      before { subject.body = 'abcd' }
+      before { subject.save }
+      it { expect(subject.body(1, 2)).to be == 'bc' }
+    end
+
+    context 'get from commit in the past' do
+      before do
+        subject.body = 'aaaa'
+        subject.save
+        @commit = subject.get_commit
+        subject.body = 'bbbb'
+        subject.save
+      end
+      it { expect(subject.body).to be == 'bbbb' }
+      it do
+        subject.checkout(@commit)
+        expect(subject.body).to be == 'aaaa'
+      end
+    end
+  end
+  
+  context '#save_with_file' do
+    context 'save if body exists' do
+      before { subject.body = 'aaaa' }
+      before { subject.save }
+      it { expect(File.read(TestPost.path(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?(TestPost.path(subject.filename))).to be_falsey }
+    end
+  end
+
+  context '#destroy_with_file' do
+    context 'delete if file exists' do
+      before { subject.body = 'aaaa' }
+      before { subject.save }
+      before { subject.destroy }
+      it { expect(File.exist?(TestPost.path(subject.filename))).to be_falsey }
+    end
+
+    context 'fine even if file does not exist' do
+      before { subject.destroy }
+      it { expect(File.exist?(TestPost.path(subject.filename))).to be_falsey }
+    end
+  end
+end
+

data/spec/model.rb

@@ -0,0 +1,18 @@
+require 'acts_as_git'
+
+ActsAsGit.configure do |config|
+  config.email = 'test@test.com'
+  config.username = 'testuser'
+end
+
+class TestPost
+  include ActsAsGit
+  def self.repodir
+    @@repodir = Dir.tmpdir
+  end
+
+  def filename
+    @filename = 'test_acts_as_git'
+  end
+  acts_as_git :body => self.instance_method(:filename)
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_git
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Satoshi Amemiya
+- Naotoshi Seo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rugged
+  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: 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: rspec-its
+  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 git repo. Save the content to a file, and load
+  the content from a file.
+email:
+- rail.sky@gmail.com
+- sonots@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- acts_as_git.gemspec
+- lib/acts_as_git.rb
+- spec/acts_as_git_spec.rb
+- spec/model.rb
+- spec/spec_helper.rb
+homepage: https://github.com/rail44/acts_as_git
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Make your field act as a git repo
+test_files:
+- spec/acts_as_git_spec.rb
+- spec/model.rb
+- spec/spec_helper.rb