pobject 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 20dc0805c434c64cf463c8d9b466592c07c05f08
+  data.tar.gz: ee6b8c53b78befa5a1ef90e3e74b0a330fecced3
+SHA512:
+  metadata.gz: d15a6cbca9c7fdb0af9b99433cea357d1c4c78e696736ed41b5e8d15d260660a2e80a430c83cada6a4f35c4160b7634e2e9e47e69e68a502beb428cb5dd904dd
+  data.tar.gz: 8cd94ca4e4692ddb785c1eaa66821e9ec9eb9462e833d49238bea4ea901aaa037a01d7797c8dabe2bbee29b7fd3b359e703f7ed8ff41e353b692f7c8ed34f7fb

data/README.md

@@ -0,0 +1,128 @@
+Persistent Object
+==================================================
+
+[![Gem](https://img.shields.io/gem/v/pobject.svg?style=flat-square)](https://rubygems.org/gems/pobject)
+[![Travis](https://img.shields.io/travis/DannyBen/pobject.svg?style=flat-square)](https://travis-ci.org/DannyBen/pobject)
+[![Code Climate](https://img.shields.io/codeclimate/github/DannyBen/pobject.svg?style=flat-square)](https://codeclimate.com/github/DannyBen/pobject)
+[![Gemnasium](https://img.shields.io/gemnasium/DannyBen/pobject.svg?style=flat-square)](https://gemnasium.com/DannyBen/pobject)
+
+---
+
+Transparently persist objects to disk as YAML or PStore files.
+
+---
+
+Install
+--------------------------------------------------
+
+```
+$ gem install pobject
+```
+
+Or with bundler:
+
+```ruby
+gem 'pobject'
+```
+
+Usage
+--------------------------------------------------
+
+Your object should inherit from PObject.
+
+```ruby
+require 'pobject'
+
+class Settings < PObject
+end
+```
+
+Now, any time you access a property, it is saved to a file. By default, we will 
+svae a YAML file with the same name as the class:
+
+
+```ruby
+class Settings < PObject
+end
+
+config = Settings.new
+config.port = 3000
+# Will create a 'settings.yml' file and store the port value
+```
+
+You can access any attributes by either dot notation or hash notation.
+
+```
+config.port
+# => 3000
+
+config[:port]
+# => 3000
+```
+
+To change the location of the file, simply override the `to_store` method.
+
+```ruby
+class Settings < PObject
+  def to_store
+    "config/local.yml"
+  end
+end
+
+config = Settings.new
+config.port = 3000
+# Will create a 'config/local.yml'
+```
+
+Whenever you use the `.yml` extension, PObject will store a YAML file. If you
+wish to store a `PStore` object instead, provide any other extension:
+
+```ruby
+class Settings < PObject
+  def to_store
+    "config/local.pstore"
+  end
+end
+```
+
+To store several objects in one store file, your `to_store` method should 
+return an array with two elements: The first, is the path to the file and 
+the second is any unique key identifying the instance.
+
+```ruby
+class Hero < PObject
+  def initialize(id)
+    @id = id
+  end
+
+  def to_store
+    ["heroes.yml", @id]
+  end
+end
+
+hammer = Hero.new :hammer
+raynor = Hero.new :raynor
+
+hammer.name = 'Sgt. Hammer'
+raynor.name = 'Raynor'
+# => 
+# ---
+# :hammer:
+#   :name: Sgt. Hammer
+# :raynor:
+#   :name: Raynor
+```
+
+By default, PObject will raise an error when accessing a property that does
+not exist. To change this behavior, call `allow_missing` at the beinning of
+your object
+
+```ruby
+class Book < PObject
+  allow_missing
+end
+
+book = Book.new
+book.author
+# => nil
+```

data/lib/pobject/pobject.rb

@@ -0,0 +1,156 @@
+require 'pstore'
+require 'yaml/store'
+
+class PObject
+  # When `allow_missing` is called at the inheriting class level, then
+  # all calls to any missing attribute will return `nil` and supress the 
+  # normal ruby behavior of raising a `NoMethodError`.
+  def self.allow_missing
+    send :define_method, :allow_missing? do
+      true
+    end
+  end
+
+  # Intercept any call to an unknown method, and try to load it from the
+  # store. If it does not exist in the store as well, then raise the usual
+  # error.
+  # This method will also be called when trying to assign to a non existing
+  # attribute. In this case, we will save it to the store.
+  def method_missing(method, args=nil, &_block)
+    if method.to_s[-1] == "="
+      set method.to_s.chomp('=').to_sym, args
+    else
+      content = get method
+      content ? content : allow_missing? ? nil : super
+    end
+  end
+
+  # Mirror the method_missing behavior.
+  def respond_to_missing?(method, include_private=false)
+    if method.to_s[-1] == "="
+      true
+    else
+      allow_missing? or !!get(method.to_sym)
+    end
+  end
+
+  # Allow hash-style access to any of our stored properties.
+  # This will not reload from the disk more than once.
+  def [](key)
+    get key
+  end
+
+  # Allow hash-style assignment to new peoperties
+  def []=(key, value)
+    set key, value
+  end
+
+  # Return a nice string when inspecting or printing. 
+  # This will load values from the store if they were not already loaded.
+  def inspect
+    properties = attributes.map { |var| [var, get(var)].join(":") }.join ', '
+    properties = " #{properties}" unless properties.empty?
+    "<#{self.class.name}#{properties}>"
+  end
+  alias_method :to_s, :inspect
+
+  # Return attribute names, so we can print them and their values in 
+  # `inspect`.
+  def attributes
+    @attributes ||= attributes!
+  end
+
+  # Return attribute names from the store.
+  # TODO: Maybe also merge with instance_variables. Pay attention to @s.
+  def attributes!
+    store.transaction { store.roots }.sort
+  end
+
+  private
+
+  # We need to have a default `allow_missing?` method, which may be 
+  # overridden by calling `allow_missing`.
+  def allow_missing?
+    false
+  end
+
+  # Get a value from the store, and set it as an instance variable so that
+  # subsequent calls do not access the disk.
+  def get(key)
+    result = instance_variable_get("@#{key}")
+    result.nil? ? get!(key) : result
+  end
+
+  # Hard get value from the store.
+  def get!(key)
+    result = store.transaction do 
+      if store_key
+        store[store_key] ||= {}
+        store[store_key][key] 
+      else
+        store[key]
+      end
+    end
+    instance_variable_set "@#{key}", result
+  end
+
+  # Set a key=value pair in the store, and in an instance variable so that
+  # any subsequent call to `get` will not have to read it from the disk.
+  # In addition, add it to the attributes list, which is used by `inspect`.
+  def set(key, value)
+    instance_variable_set "@#{key}", value
+    attributes << key unless attributes.include? key
+    store.transaction do
+      if store_key
+        store[store_key] ||= {}
+        store[store_key][key] = value
+      else
+        store[key] = value
+      end
+    end 
+  end
+
+  # The default store location. May be overridden by the inheriting class.
+  def to_store
+    "#{self.class.to_s.downcase}.yml"
+  end
+
+  # Return the actual store object. It can either be a YAML::Store or a 
+  # PStore, which behave exactly the same.
+  def store
+    @store ||= store!
+  end
+
+  # Hard get the actual store object, based on the provided file extension.
+  def store!
+    if ['.yml', 'yaml'].include?(store_file[-4,4]) 
+      YAML::Store.new(store_file) 
+    else
+      PStore.new(store_file)
+    end
+  end
+
+  # Return the store filename.
+  def store_file
+    @store_file ||= store_file! 
+  end
+
+  # Hard return the store filename based on the value of `to_store`.
+  # If an array, the first element is the path.
+  def store_file!
+    to_store.is_a?(Array) ? to_store[0] : to_store
+  end
+
+  # Return the key to use in case multiple objects are to be saved in the
+  # same file.
+  def store_key
+    @store_key.nil? ? @store_key = store_key! : @store_key
+  end
+
+  # Hard return the store key based on the `to_store` value. If an array,
+  # the second element represents the key.
+  def store_key!
+    to_store.is_a?(Array) ? to_store[1] : false
+  end
+
+end

data/lib/pobject/version.rb

@@ -0,0 +1,3 @@
+class PObject
+  VERSION = "0.1.0"
+end

data/lib/pobject.rb

@@ -0,0 +1,2 @@
+require 'pobject/version'
+require 'pobject/pobject'

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: pobject
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Danny Ben Shitrit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: runfile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: runfile-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+description: Auto save objects as files
+email: db@dannyben.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/pobject.rb
+- lib/pobject/pobject.rb
+- lib/pobject/version.rb
+homepage: https://github.com/DannyBen/pobject
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Persistent Object
+test_files: []