PackingPeanut 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12a47cd8b03f2575cbec3c3768afd5827e3459f7
-  data.tar.gz: 07bdafd4af83852cd593c96af077634284d3370f
+  metadata.gz: e2f04de5df63f75fb232e267e56ce3f33bc0eefb
+  data.tar.gz: 9ad3ba2c1db95ad649252daa5a85c7c786d12419
 SHA512:
-  metadata.gz: 2298a6a63b15c41318495495b3c9b64b30fe3f80c6f96673e92ba7df7f0c10331441b1ad4e99b217b2272123efe9995e83c68decc9161473f134ff0e07ca03ae
-  data.tar.gz: 44023b702723b79591bb23bad85b1c4d2f18c330515a382cdcada4bde59c8ae5ffc02aa17ca91faf8303f6369fbcdba451fad2bf476ad19a14b8603331acdcc9
+  metadata.gz: 6fc18eab2b1d752c17d3c8f78df711e4f53fe66ecdf8bb94940b457c8d8be0adbfe857eda9822b69b526857cc3d90c9b21f831e57bb46ea312b4a14b8812c001
+  data.tar.gz: b752f132729c59c907d92b1f075bcff4aee493cfe8a35b519303c3a59c190612f2cfc3650204602209d777faec73722f181c04cb29c567e8e9129468d23c76a3

data/README.md

@@ -1,8 +1,11 @@
 # ![PackingPeanut Logo](./_art/logo_100.png) PackingPeanut [![Gem Version](https://badge.fury.io/rb/PackingPeanut.svg)](http://badge.fury.io/rb/PackingPeanut)
 
-iOS has [BubbleWrap](https://github.com/rubymotion/BubbleWrap) for App Persistence : Android has PackingPeanut
+### Cross Platform App Persistence
+![cross platform rubymotion gem](./_art/both_icon.png)
 
-There is a sedulous effort to make this syntax fit BubbleWrap's as much as possible, but differences simply exist, either for good, technical, or sometimes diabolical reasons :smiling_imp:
+Inspired by BubbleWrap's easy syntax for App Persistence - Now a CROSS PLATFORM App Persistence Gem for RubyMotion.
+
+There is a sedulous effort to make this syntax fit BubbleWrap's as much as possible for easy replacement :smiling_imp:
 
 [**GITHUB HOMEPAGE**](http://gantman.github.io/PackingPeanut/)
 
@@ -16,6 +19,10 @@ There is a sedulous effort to make this syntax fit BubbleWrap's as much as possi
 
     $ bundle
 
+**Step 3:** IF on Android:
+
+    $ [bundle exec] rake gradle:install
+
 ## Usage
 
 **It's as simple as:**
@@ -26,32 +33,34 @@ App::Persistence[:foo] = true
 
 Whirlwind Tour via the REPL
 ```
-# PP automatically has context if the module is included
-# In this case we need to set the context
+# ONLY ANDROID REQUIRES CONTEXT!
+# Set the context (required in the REPL or when not including the module).
 $ App::Persistence.context = self
 => #<MainActivity:0x1d20058e>
 $ App::Persistence['dinner'] = "nachos"
-=> true  # This differs from Bubblewrap.... boolean on success for save (more informative)
-$ App::Persistence['dinner'] 
+=> "nachos"
+$ App::Persistence['dinner']
 => "nachos"
 $ App::Persistence[:lunch] = "tacos"
 => "tacos" # Use symbols or strings as you please
 $ App::Persistence.all
-=> [{:dinner=>"nachos"}, {:lunch=>"tacos"}]
+=> {"dinner"=>"nachos", "lunch"=>"tacos"}
 $ App::Persistence.storage_file = "some_new_file"
 => "some_new_file"
 $ App::Persistence['dinner']
 => ""  # empty because we're now outside the default storage file.
-$ App::Persistence.preference_mode = :world_readable
-=> :world_redable
-$ PP::Persistence['some_boolean'] = true #You can use PP instead of App if you like
-```
 
+# You can use PP instead of App::Persistence if you like
+$ PP['some_boolean'] = true
 
+# On Android you can set prefrence_modes for cross/app communication
+$ App::Persistence.preference_mode = :world_readable
+=> :world_readable
+```
 
 ## What are preference modes?
 
-Preference Modes are ANdroid Operating modes. Use 0 or MODE_PRIVATE for the default operation, MODE_WORLD_READABLE and MODE_WORLD_WRITEABLE to control permissions. The bit MODE_MULTI_PROCESS can also be used if multiple processes are mutating the same SharedPreferences file. MODE_MULTI_PROCESS is always on in apps targeting Gingerbread (Android 2.3) and below, and off by default in later versions.
+Preference Modes are Android Operating modes, used to control permission levels on the persistence file.
 
 Memorizable symbols and their corresponding constants:
 ```ruby
@@ -66,11 +75,15 @@ Memorizable symbols and their corresponding constants:
     }
 ```
 
-## Limitations?
-Achilles, the Death Star, and video game villians always have a significant catch.   As of right now, you can only store **strings, ints, and booleans**.   The data is serialized, and should support hashes, arrays, and floats but alas, I claim there be bugs in conversions via RM Android.
+Use 0 or MODE_PRIVATE for the default operation, MODE_WORLD_READABLE and MODE_WORLD_WRITEABLE for more permissive modes. The bit MODE_MULTI_PROCESS can also be used if multiple processes are mutating the same SharedPreferences file. MODE_MULTI_PROCESS is always on in apps targeting Gingerbread (Android 2.3) and below, and off by default in later versions.
+
+## Dependencies
+Adding [Darin's moran gem](https://github.com/darinwilson/moran) allowed serialization of hashes for Android.  This means `motion-gradle` is also necessary for complete Packing Peanut excellence on Android.
 
 ## Tests?
-Boy that would be nice wouldn't it?
+
+  * **iOS:** Yup!
+  * **Android:** Boy that would be nice wouldn't it?
 
 ## Contributing
 

data/lib/{project → PackingPeanut-android}/PackingPeanut.rb

@@ -23,27 +23,29 @@ module App
     # Serialize key/value as json then
     # store that string with the settings key == json key
     def []=(key, value)
+      # Let's play nice with strings and non-strings
+      string_key = key.to_s
       settings = get_settings
       editor = settings.edit
-      json = serialize(key,value)
-      editor.putString(key, json.toString)
-      editor.commit 
+      json = serialize(string_key,value)
+      editor.putString(string_key, json.toString)
+      editor.commit
     end
 
     def [](key)
-      json_string = get_value(key)
+      # Let's play nice with strings and non-strings
+      string_key = key.to_s
+      json_string = get_value(string_key)
       return json_string if json_string == ""
-      deserialize(key, json_string)
+      deserialize(string_key, json_string)
     end
 
     def serialize(key, value)
-      json = JSONObject.new
-      json.put(key, value)
+      Moran.generate({:"#{key}" => value})
     end
 
     def deserialize(key, json_string)
-      json = JSONObject.new(json_string)
-      json.get(key)
+      Moran.parse(json_string)[key]
     end
 
     def get_value key
@@ -69,7 +71,15 @@ module App
 
     def all
       settings = get_settings
-      settings.getAll.map { |key, value| {key.to_sym => JSONObject.new(value).get(key)} }
+      all_hashes = settings.getAll.map { |key, value| Moran.parse(value) }
+
+      # Currently an array of hashes, needs to be one big hash
+      merged_hashes = {}
+      all_hashes.each do |h|
+        merged_hashes = merged_hashes.merge(h)
+      end
+
+      merged_hashes
     end
 
     def get_settings
@@ -79,15 +89,17 @@ module App
     # Allows us to use this from anywhere by setting the context
     # Useful when you want to access this module from the REPL
     def current_context
+      #p defined? getApplicationContext
       @context || getApplicationContext
     end
 
     # attr_accessor is not supported for modules in RMAndroid... yet.
-    def context= supplied_context 
+    def context= supplied_context
       @context = supplied_context
     end
 
   end
 end
 
-PP = App
+# delicious shortcut
+PP = App::Persistence unless defined? PP

data/lib/PackingPeanut-ios/PackingPeanut.rb

@@ -0,0 +1,68 @@
+# Persistence module built on top of NSUserDefaults
+module App
+  module Persistence
+    module_function
+
+    def app_key
+      @app_key ||= NSBundle.mainBundle.bundleIdentifier
+    end
+
+    def storage_file
+      @persistence_storage_file ||= "default_persistence_file"
+    end
+
+    def storage_file=(value)
+      @persistence_storage_file = value
+    end
+
+    def []=(key, value)
+      storage.setObject(value, forKey: storage_key(key))
+      storage.synchronize
+    end
+
+    def [](key)
+      value = storage.objectForKey storage_key(key)
+
+      # RubyMotion currently has a bug where the strings returned from
+      # standardUserDefaults are missing some methods (e.g. to_data).
+      # And because the returned object is slightly different than a normal
+      # String, we can't just use `value.is_a?(String)`
+      value.class.to_s == 'String' ? value.dup : value
+    end
+
+    def merge(values)
+      values.each do |key, value|
+        storage.setObject(value, forKey: storage_key(key))
+      end
+      storage.synchronize
+    end
+
+    def delete(key)
+      value = storage.objectForKey storage_key(key)
+      storage.removeObjectForKey(storage_key(key))
+      storage.synchronize
+      value
+    end
+
+    def storage
+      NSUserDefaults.standardUserDefaults
+    end
+
+    def storage_key(key)
+      "#{app_key}_#{storage_file}_#{key}"
+    end
+
+    def all
+      hash = storage.dictionaryRepresentation.select{|k,v| k.start_with?("#{app_key}_#{storage_file}") }
+      new_hash = {}
+      hash.each do |k,v|
+        new_hash[k.sub("#{app_key}_#{storage_file}_", '')] = v
+      end
+      new_hash
+    end
+  end
+
+end
+
+# delicious shortcut
+PP = App::Persistence unless defined? PP

data/lib/PackingPeanut-ios/ns_user_defaults.rb

@@ -0,0 +1,15 @@
+# Reopens the NSUserDefaults class to add Array like accessors
+# @see https://developer.apple.com/library/ios/#documentation/Cocoa/Reference/Foundation/Classes/nsuserdefaults_Class/Reference/Reference.html
+class NSUserDefaults
+
+  # Retrieves the object for the passed key
+  def [](key)
+    self.objectForKey(key.to_s)
+  end
+
+  # Sets the value for a given key and save it right away.
+  def []=(key, val)
+    self.setObject(val, forKey: key.to_s)
+    self.synchronize
+  end
+end

data/lib/PackingPeanut.rb

@@ -1,12 +1,32 @@
 # encoding: utf-8
-
 unless defined?(Motion::Project::Config)
-  raise "This file must be required within a RubyMotion project Rakefile."
+  raise "The PackingPeanut gem must be required within a RubyMotion project Rakefile."
+end
+
+# WHAT ARE WE?
+platform = Motion::Project::App.respond_to?(:template) ? Motion::Project::App.template : :ios
+if platform.to_s.start_with?('ios')
+  platform_name = 'ios'
+elsif platform.to_s.start_with?('android')
+  platform_name = 'android'
 end
 
-lib_dir_path = File.dirname(File.expand_path(__FILE__))
+# necessary for Android gem dependency as of 5/9/2015
+require "moran" if platform_name == "android"
+
 Motion::Project::App.setup do |app|
-  app.files.unshift(Dir.glob(File.join(lib_dir_path, "project/**/*.rb")))
-  # Required for android as off 4/11/2015
-  app.files.flatten!
+  platform_lib = File.join(File.dirname(__FILE__), "PackingPeanut-#{platform_name}")
+  unless File.exists? platform_lib
+    raise "Sorry, the platform #{platform.inspect} (aka #{platform_name}) is not supported by PackingPeanut"
+  end
+
+  # scans app.files until it finds app/ (the default)
+  # if found, it inserts just before those files, otherwise it will insert to
+  # the end of the list
+  insert_point = app.files.find_index { |file| file =~ /^(?:\.\/)?app\// } || 0
+
+  Dir.glob(File.join(platform_lib, '**/*.rb')).reverse.each do |file|
+    app.files.insert(insert_point, file)
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: PackingPeanut
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Gant
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-13 00:00:00.000000000 Z
+date: 2015-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -24,7 +24,35 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: App persistent data for RubyMotion Android
+- !ruby/object:Gem::Dependency
+  name: moran
+  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-gradle
+  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: App persistent data for RubyMotion Android and iOS
 email:
 - GantMan@gmail.com
 executables: []
@@ -32,8 +60,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- lib/PackingPeanut-android/PackingPeanut.rb
+- lib/PackingPeanut-ios/PackingPeanut.rb
+- lib/PackingPeanut-ios/ns_user_defaults.rb
 - lib/PackingPeanut.rb
-- lib/project/PackingPeanut.rb
 homepage: http://gantman.github.io/PackingPeanut/
 licenses:
 - MIT
@@ -57,6 +87,6 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: App persistent data for RubyMotion Android, designed to fit the API stylings
-  of the popular iOS Gem BubbleWrap which also supplies persistence.
+summary: App persistent data for RubyMotion Android and iOS, designed to fit the API
+  stylings of the popular iOS Gem BubbleWrap which also supplies persistence.
 test_files: []