motion-persistable 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9dd19726462662517ea8c12e098630b8918796cf
+  data.tar.gz: 1d7e6d702c4db54d666043026b2cd621b568adea
+SHA512:
+  metadata.gz: 4b4ead8d44ef350bfc4431b05733eb9358ce69896055b42c606d04cbfd3235f4630e53edb42e2964a2892915769faa3bd2ee56acaa34208de29c2b3e5ab5b8ae
+  data.tar.gz: 02e31160b124ae2c2fd90694254cc61a7d3ce642ed1aede1ced365b968b94b0007ca919fe3df88fe83c3f4d260d301ebb5e2a81019cc93d523c969c7241fc39f

data/.gitignore

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

data/.repl_history

@@ -0,0 +1,20 @@
+User
+exit
+User.new.age
+User.new.email
+User.new('theore').age
+User.new('theore').age
+domainName = NSBundle.mainBundle.bundleIdentifier
+NSUserDefaults.standardUserDefaults.removePersistentDomainForName(domainName)
+User.new('theore').age
+User.new('theore').age = 14
+User.new('theore').age
+domainName = NSBundle.mainBundle.bundleIdentifier
+NSUserDefaults.standardUserDefaults.removePersistentDomainForName(domainName)
+User.new('theore').age
+exit
+User.new("Bodacious").last_signed_in = Time.now
+User.new("Bodacious").last_sign_in = Time.now
+STDOUT
+STDOUT.read
+exit

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Bodacious
+
+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,74 @@
+# Motion::Persistable
+
+## Persistable attributes for Rubymotion classes
+
+A nice wrapper around Bubble-wrap's App::Persistence module that adds class macros for attributes that are persistable
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'motion-persistable'
+
+And then execute:
+
+    $ bundles
+
+Add this line to your application's Rakefile:
+    
+    Bundler.require # this should already be there
+    require 'motion-persistable'
+
+Or install it yourself as:
+
+    $ gem install motion-persistable
+
+## Usage
+
+Include the module Motion::Persistable in any class that you want persistable attributes
+
+### Persistable Instance Methods
+
+    class User
+  
+      include Motion::Persistable
+  
+      # Define this in your model to use your own key, otherise it will try and call 
+      # name() on the instance by default
+      def persistence_key
+        "User"
+      end
+      
+      # This will persist the user's email under the key: "User.bodacious.email" (where the
+      # user's username was bodacious)
+      attr_persisted :email, '', :username
+
+      # This will set an attribute called age, with a default value of 16.
+      # When a new value is set, the block is called, in this case it's recorded on TestFlight
+      attr_persisted :age, 16, :username do |value|
+        testflight_checkpoint("Set new age value", age: value)
+      end
+  
+      class << self 
+        include Motion::Persistable # for class methods
+
+        # This will set a class attribute User.count with a default value of 0
+        attr_persisted :count, 0
+      end
+  
+    end
+  
+
+## Considerations
+
+The obvious drawback with this current approach is that instances require unique keys.
+For the project this was designed for, this wasn't an issue but if your instances don't 
+already have some sort of unique identifier then this gem might not be best for you.
+
+## 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,14 @@
+require "bundler/gem_tasks"
+
+
+$:.unshift('/Library/RubyMotion/lib')
+require 'motion/project/template/ios'
+require 'bundler'
+
+Bundler.require
+require 'motion/persistable'
+
+Motion::Project::App.setup do |app|
+  # Use `rake config' to see complete project settings.
+  app.name = 'Motion-Persistable'
+end

data/app/app_delegate.rb

@@ -0,0 +1,5 @@
+class AppDelegate
+  def application(application, didFinishLaunchingWithOptions:launchOptions)
+    true
+  end
+end

data/app/user.rb

@@ -0,0 +1,30 @@
+class User
+  
+  attr_accessor :username
+  
+  include Motion::Persistable
+  
+  attr_persisted :email, ''
+  
+  attr_persisted :age, 16
+  
+  attr_persisted :location
+  
+  attr_persisted :last_sign_in, nil do |value|
+    App::Persistence['last_sign_in'] = value
+  end
+  
+  class << self
+    include Motion::Persistable
+    attr_persisted :last_signed_in_user
+  end
+  
+  def initialize(username)
+    self.username = username 
+  end
+  
+  def name
+    username
+  end
+  
+end

data/lib/motion/persistable/version.rb

@@ -0,0 +1,5 @@
+module Motion
+  module Persistable
+    VERSION = "0.0.2"
+  end
+end

data/lib/motion/persistable.rb

@@ -0,0 +1,49 @@
+module Motion
+  module Persistable
+    
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    def persistence_key
+      if respond_to?(:key)
+        key
+      else
+        name
+      end
+    end
+  
+    module ClassMethods
+  
+      def attr_persisted(method_name, default_value = nil, key_suffix = nil, &block)
+        callback = block if block_given?
+
+        instance_eval do
+              
+          define_method method_name do
+            if App::Persistence[send("_#{method_name}_key")].nil? and default_value
+              App::Persistence[send("_#{method_name}_key")] = default_value
+            end          
+            App::Persistence[send("_#{method_name}_key")]
+          end
+      
+          define_method "#{method_name}=" do |value|
+            App::Persistence[send("_#{method_name}_key")] = value
+            callback.call(value) if callback
+            App::Persistence[send("_#{method_name}_key")]
+          end
+      
+          define_method "_#{method_name}_key" do
+            key_suffix = send(key_suffix) if key_suffix.is_a?(Symbol)
+            [persistence_key, key_suffix, method_name].compact.join('.')
+          end
+      
+          private "_#{method_name}_key"
+      
+        end
+      end
+
+    end
+
+  end
+end

data/lib/motion-persistable.rb

@@ -0,0 +1,15 @@
+unless defined?(Motion::Project::Config)
+  raise "This file must be required within a RubyMotion project Rakefile."
+end
+
+require 'bubble-wrap/core'
+
+require 'motion/persistable/version'
+
+Motion::Project::App.setup do |app|
+  path_string = File.join(File.dirname(__FILE__), 'motion/persistable.rb')
+  Dir.glob(path_string).each do |file|
+    app.files.unshift(file)
+  end
+end
+

data/motion-persistable.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'motion/persistable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "motion-persistable"
+  spec.version       = Motion::Persistable::VERSION
+  spec.authors       = ["Bodacious"]
+  spec.email         = ["gavin@katanacode.com"]
+  spec.description   = %q{Persistable attributes for Rubymotion classes}
+  spec.summary       = %q{A nice wrapper around Bubble-wrap's App::Persistence module that adds class macros for attributes that are persistable}
+  spec.homepage      = "http://github.com/KatanaCode/motion-persistable"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'bubble-wrap'
+  spec.add_development_dependency 'motion-stump'
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/spec/user_spec.rb

@@ -0,0 +1,79 @@
+describe "User" do
+  before do
+    @user = User.new('bodacious')
+  end
+
+  after do
+    # Clear out the cache
+    domainName = NSBundle.mainBundle.bundleIdentifier
+    NSUserDefaults.standardUserDefaults.removePersistentDomainForName(domainName)
+  end
+  
+  describe "email" do
+
+    it "is persisted between instances" do
+      @user.email = "bodacious@katanacode.com"
+      @user       = User.new("bodacious")
+      @user.email.should == "bodacious@katanacode.com"
+    end
+    
+    it "defaults to an empty string" do
+      @user = User.new("other-user")
+      @user.email.should == ""
+    end  
+    
+  end
+
+  describe "age" do
+
+    it "defaults to 16" do
+      @user = User.new("other-user")
+      @user.age.should == 16
+    end  
+
+    it "is persisted between instances" do
+      @user.age = 28
+      @user     = User.new("bodacious")
+      @user.age.should == 28
+    end
+    
+  end
+  
+  describe "location" do
+
+    it "defaults to nil" do
+      @user = User.new("other-user")
+      @user.location.should == nil
+    end  
+
+    it "is persisted between instances" do
+      @user.location = "Edinburgh"
+      @user     = User.new("bodacious")
+      @user.location.should == "Edinburgh"
+    end
+    
+  end
+  
+  describe "last_sign_in" do
+  
+    it "defaults to nil" do
+      @user = User.new("other-user")
+      @user.last_sign_in.should == nil
+    end 
+    
+    it "is persisted between instances" do
+      @user.last_sign_in = Time.now
+      @user     = User.new("bodacious")
+      @user.last_sign_in.should != nil
+    end 
+    
+    it "calls the callback block when set" do
+      User.last_signed_in_user = nil
+      time = Time.now
+      @user.last_sign_in = time
+      App::Persistence['last_sign_in'].should == time
+    end
+    
+  end
+  
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: motion-persistable
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Bodacious
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bubble-wrap
+  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: motion-stump
+  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: 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'
+description: Persistable attributes for Rubymotion classes
+email:
+- gavin@katanacode.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .repl_history
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/app_delegate.rb
+- app/user.rb
+- lib/motion-persistable.rb
+- lib/motion/persistable.rb
+- lib/motion/persistable/version.rb
+- motion-persistable.gemspec
+- spec/user_spec.rb
+homepage: http://github.com/KatanaCode/motion-persistable
+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.1.11
+signing_key: 
+specification_version: 4
+summary: A nice wrapper around Bubble-wrap's App::Persistence module that adds class
+  macros for attributes that are persistable
+test_files:
+- spec/user_spec.rb