active_pstore 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ce4d5fd7b68f1d584089e97ec4def1991c31bc0b
+  data.tar.gz: 35d4299645636ba48b0ee2201eed2c531ca69e1c
+SHA512:
+  metadata.gz: 96b1291e03675054463557a341f2b41ad8318c91973538e3cea7392ac1bc89d523156f6d00b7588a55814d3875e0630b91116920a29d6d4408fa1c51974430dd
+  data.tar.gz: 1462643017e90750bab55d9cd0a5dd8d4b4e2037b3653dc4505e44a2415bc5858a8eedffff66b60fa662654113ddee50962fc3ddc460dc77d98355ba1546abb1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2015 Koichi ITO
+
+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.ja.md

@@ -0,0 +1,109 @@
+# Active PStore [Active Record](https://github.com/rails/rails/tree/master/activerecord)に似たインターフェイスを持ったライブラリです。
+データの保存には[pstore](http://docs.ruby-lang.org/ja/2.2.0/library/pstore.html)を使います。
+
+## FEATURES/PROBLEMS
+
+* それなりに問題を持っています
+* トランザクションをサポートしてません
+* データマイグレーションをサポートしてません
+* パフォーマンス (特に実装面とか)
+* これらのことからエンタープライズ要件には向かないです
+
+## SYNOPSIS
+
+### クラス定義とインスタンスの生成
+
+```
+require 'active_pstore'
+
+class Artist < ActivePStore::Base
+  def initialize(name)
+    @name = name
+  end
+
+  attr_reader :name
+end
+
+randy_rhoads = Artist.new('Randy Rhoads')
+```
+
+### データの保存先のファイルパス指定
+
+```
+Artist.establish_connection(database: '/path/to/file')
+```
+
+### インスタンスの保存
+
+```
+randy_rhoads.save
+```
+
+saveメソッドの対象オブジェクトのクラス名がPStoreのキーになります。
+
+```
+database = PStore.new('/path/to/file')
+database.transaction {|db| artist = db['Artist'] } # fetch instances of Artist class.
+```
+
+保存時に[SecureRandom.hex](http://docs.ruby-lang.org/ja/2.2.0/class/SecureRandom.html#S_HEX)の値を使ったActivePStore::Base#idが付与されます。
+
+```
+> randy_rhoads.id # => nil 
+> randy_rhoads.save
+> randy_rhoads.id # => "0b84ece5d5be3bce3ee2101c1c4f6fda"
+```
+
+### 検索系
+
+```
+Artist.all
+Artist.first
+Artist.last
+Artist.find('388980778246cbcbfcbb7a8292f28c37')
+Artist.where(name: 'Randy Rhoads')
+```
+
+範囲指定
+
+```
+Artist.where(birth_date: Date.new(1948, 12, 3)..Date.new(1956, 12, 6))
+```
+
+続きはテストコードをご参照ください。
+
+## REQUIREMENTS
+
+* no requirements
+
+## INSTALL
+
+Add these lines to your application's Gemfile:
+
+```
+gem 'active_pstore'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install active_pstore
+```
+
+## LICENCE
+
+The MIT Licence
+
+## 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/README.md

@@ -0,0 +1,110 @@
+# Active PStore [![Build Status](https://travis-ci.org/koic/active-pstore.svg)](https://travis-ci.org/koic/active-pstore) [![Code Climate](https://codeclimate.com/github/koic/active-pstore/badges/gpa.svg)](https://codeclimate.com/github/koic/active-pstore) [![Test Coverage](https://codeclimate.com/github/koic/active-pstore/badges/coverage.svg)](https://codeclimate.com/github/koic/active-pstore/coverage) [![Gem Version](https://badge.fury.io/rb/active_pstore.svg)](http://badge.fury.io/rb/active_pstore)
+
+This library has [Active Record](https://github.com/rails/rails/tree/master/activerecord) like interface. Use [pstore](http://docs.ruby-lang.org/en/2.2.0/PStore.html) to store data.
+
+## FEATURES/PROBLEMS
+
+* Oh so many problems...
+* Transaction NOT supported
+* Data Migration NOT supported
+* Performance (caused by implementation)
+* and Not solving the root cause for enterprise...
+
+## SYNOPSIS
+
+### class definition and instantiate
+
+```
+require 'active_pstore'
+
+class Artist < ActivePStore::Base
+  def initialize(name)
+    @name = name
+  end
+
+  attr_reader :name
+end
+
+randy_rhoads = Artist.new('Randy Rhoads')
+```
+
+### specify data store path
+
+```
+Artist.establish_connection(database: '/path/to/file')
+```
+
+### save
+
+```
+randy_rhoads.save
+```
+
+database key is string of class name.
+
+```
+database = PStore.new('/path/to/file')
+database.transaction {|db| artist = db['Artist'] } # fetch instances of Artist class.
+```
+
+allocate value of ActivePStore::Base#id using [SecureRandom.hex](http://ruby-doc.org/stdlib-2.2.0/libdoc/securerandom//rdoc/SecureRandom.html#method-c-hex).
+
+```
+> foo.id # => nil 
+> randy_rhoads.save
+> foo.id # => "0b84ece5d5be3bce3ee2101c1c4f6fda"
+```
+
+### find series
+
+```
+Artist.all
+Artist.first
+Artist.last
+Artist.find('388980778246cbcbfcbb7a8292f28c37') # ActivePStore::Base#id is an SecureRandom.hex value
+Artist.where(name: 'Randy Rhoads')
+```
+
+Range
+
+```
+Artist.where(birth_date: Date.new(1948, 12, 3)..Date.new(1956, 12, 6))
+```
+
+see spec codes for more information.
+
+## REQUIREMENTS
+
+no requirements
+
+## INSTALL
+
+Add these lines to your application's Gemfile:
+
+```
+gem 'active_pstore'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install active_pstore
+```
+
+## LICENCE
+
+The MIT Licence
+
+## 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/lib/active_pstore/base.rb

@@ -0,0 +1,23 @@
+module ActivePStore
+  class Base
+    extend ActivePStore::ConnectionHandling
+    extend ActivePStore::FinderMethods
+    extend ActivePStore::Inheritance
+    extend ActivePStore::Querying
+    extend ActivePStore::QueryMethods
+    include ActivePStore::Core
+    include ActivePStore::Persistence
+
+    class << self
+      def all
+        use_connection do |connection|
+          ActivePStore::Collection.new(connection[self.pstore_key] || [])
+        end
+      end
+
+      def pstore_key
+        self.to_s
+      end
+    end
+  end
+end

data/lib/active_pstore/collection.rb

@@ -0,0 +1,33 @@
+module ActivePStore
+  class Collection
+    def initialize(objects)
+      @objects = objects
+    end
+
+    def update_all(updates)
+      @objects.each {|obj|
+        obj.update_attributes(updates)
+      }.count
+    end
+
+    def destroy_all
+      @objects.inject(0) {|result, obj|
+        obj.destroy
+
+        result += 1
+      }
+    end
+
+    def count
+      @objects.count
+    end
+
+    def empty?
+      @objects.empty?
+    end
+
+    def method_missing(method_name, *args, &block)
+      @objects.__send__(method_name, *args, &block)
+    end
+  end
+end

data/lib/active_pstore/connection_handling.rb

@@ -0,0 +1,21 @@
+require 'pstore'
+
+module ActivePStore
+  module ConnectionHandling
+    def establish_connection(options)
+      unless options.is_a? Hash
+        raise ArgumentError, "You must specify at database configuration. Example: ActivePStore::Base.establish_connection(database: '/path/to/file')"
+      end
+
+      @@db = PStore.new((options[:database] || options['database']).to_s)
+    end
+
+    def use_connection
+      @@db.transaction do |pstore|
+        yield pstore
+      end
+    rescue # uninitialized class variable @@db in ActivePStore::Base
+      raise ActivePStore::ConnectionNotEstablished, "Raised when connection to the pstore file path could not been established (for example when ActivePStore.establish_connection(database: '/path/to/file') is given a nil object)."
+    end
+  end
+end

data/lib/active_pstore/core.rb

@@ -0,0 +1,20 @@
+module ActivePStore
+  module Core
+    def ==(comparison_object)
+      if id
+        comparison_object.instance_of?(self.class) && comparison_object.id == id
+      else
+        super
+      end
+    end
+    alias :eql? :==
+
+    def hash
+      if id
+        id.hash
+      else
+        super
+      end
+    end
+  end
+end

data/lib/active_pstore/errors.rb

@@ -0,0 +1,4 @@
+module ActivePStore
+  class ConnectionNotEstablished < StandardError; end
+  class RecordNotFound < StandardError; end
+end

data/lib/active_pstore/finder_methods.rb

@@ -0,0 +1,29 @@
+module ActivePStore
+  module FinderMethods
+    def find(id)
+      id = id.is_a?(ActivePStore::Base) ? id.id : id
+
+      all.find {|obj| obj.id == id } || (raise ActivePStore::RecordNotFound, "Couldn't find #{self} with 'id'=#{id}")
+    end
+
+    def find_by(conditions = {})
+      where(conditions).first
+    end
+
+    def find_by!(conditions = {})
+      find_by(conditions) || (raise ActivePStore::RecordNotFound, "Couldn't find #{self} with conditions=#{conditions}")
+    end
+
+    def first
+      all.first
+    end
+
+    def last
+      all.last
+    end
+
+    def take(limit = nil)
+      limit ? all.take(limit) : first
+    end
+  end
+end

data/lib/active_pstore/inheritance.rb

@@ -0,0 +1,11 @@
+module ActivePStore
+  module Inheritance
+    def new(*args)
+      if self == ActivePStore::Base
+        raise NotImplementedError, "#{self} is an abstract class and cannot be instantiated."
+      else
+        super
+      end
+    end
+  end
+end

data/lib/active_pstore/persistence.rb

@@ -0,0 +1,51 @@
+require 'securerandom'
+
+module ActivePStore
+  module Persistence
+    attr_reader :id
+
+    def destroy
+      ActivePStore::Base.use_connection do |connection|
+        connection[self.class.pstore_key].delete_if {|obj| obj.id == self.id }
+      end
+
+      self
+    end
+
+    def new_record?
+      @id.nil?
+    end
+
+    def save
+      ActivePStore::Base.use_connection do |connection|
+        if new_record?
+          @id = SecureRandom.hex
+
+          if connection[self.class.pstore_key]
+            connection[self.class.pstore_key] << self
+          else
+            connection[self.class.pstore_key] = [self]
+          end
+        else
+          connection[self.class.pstore_key].map! {|obj| obj.id == self.id ? self : obj }
+        end
+      end
+
+      true
+    end
+
+    def update_attribute(attr_name, attr_value)
+      self.__send__("#{attr_name}=", attr_value)
+
+      save
+    end
+
+    def update_attributes(attrs)
+      attrs.each do |attr_name, attr_value|
+        self.__send__("#{attr_name}=", attr_value)
+      end
+
+      save
+    end
+  end
+end

data/lib/active_pstore/query_methods.rb

@@ -0,0 +1,21 @@
+module ActivePStore
+  module QueryMethods
+    def where(conditions = {})
+      ret = all
+
+      return ret if conditions.empty?
+
+      conditions.each do |key, value|
+        ret = ret.select {|obj|
+        if value.is_a? Range
+          value.include?(obj.__send__(key))
+        else
+          obj.__send__(key) == value
+        end
+        }
+      end
+
+      ActivePStore::Collection.new(ret)
+    end
+  end
+end

data/lib/active_pstore/querying.rb

@@ -0,0 +1,19 @@
+module ActivePStore
+  module Querying
+    def update_all(updates)
+      all.update_all(updates)
+    end
+
+    def destroy_all
+      all.destroy_all
+    end
+
+    def count
+      all.count
+    end
+
+    def emtpy?
+      all.empty?
+    end
+  end
+end

data/lib/active_pstore/timestamps.rb

@@ -0,0 +1,14 @@
+module ActivePStore
+  module Timestamps
+    module Created
+      attr_accessor :created_at
+    end
+
+    module Updated
+      attr_accessor :updated_at
+    end
+
+    include Created
+    include Updated
+  end
+end

data/lib/active_pstore/version.rb

@@ -0,0 +1,3 @@
+module ActivePStore
+  VERSION = '0.4.0'
+end

data/lib/active_pstore.rb

@@ -0,0 +1,12 @@
+module ActivePStore; end
+
+require 'active_pstore/collection'
+require 'active_pstore/connection_handling'
+require 'active_pstore/core'
+require 'active_pstore/finder_methods'
+require 'active_pstore/inheritance'
+require 'active_pstore/persistence'
+require 'active_pstore/query_methods'
+require 'active_pstore/querying'
+require 'active_pstore/base'
+require 'active_pstore/errors'

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: active_pstore
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Koichi ITO
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: This library has Active Record like interface. Use pstore to store data.
+email: koic.ito@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.ja.md
+- README.md
+- lib/active_pstore.rb
+- lib/active_pstore/base.rb
+- lib/active_pstore/collection.rb
+- lib/active_pstore/connection_handling.rb
+- lib/active_pstore/core.rb
+- lib/active_pstore/errors.rb
+- lib/active_pstore/finder_methods.rb
+- lib/active_pstore/inheritance.rb
+- lib/active_pstore/persistence.rb
+- lib/active_pstore/query_methods.rb
+- lib/active_pstore/querying.rb
+- lib/active_pstore/timestamps.rb
+- lib/active_pstore/version.rb
+homepage: http://github.com/koic/active_pstore
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: This library has Active Record like interface. Use pstore to store data.
+test_files: []