PackingPeanut 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6d208f0c0b6fbf825d0f2d38726f34d74186934
-  data.tar.gz: c9a3ea3e898985b0f68ddbe33a87ed9b65a1a9c2
+  metadata.gz: 98a56da3d30642faebb8dda8ba695b5eb14bf95a
+  data.tar.gz: 6025bffcaf7d9c5043f99d31280505e7bc2e52b6
 SHA512:
-  metadata.gz: 09cf80f1b1a521e94a1d43dc507b4ad3235ad3e5761c17343c60691072e372379df46383138c4634b58e8c759f8a2c6e6171d8d43b6ba21e5e0ec02d5652c31e
-  data.tar.gz: 96de1ad83d856a6f2780b4c9bbd33de9c47bc0652ac567e3c77d5b211cfc1f8cf5539a82d181e481e921e4a4e5d37432d6ed4c13b5c889d7031d57251071c1ef
+  metadata.gz: 5f38cf057b95e26e27e735bad06a1bde33a52939ad80f86a68ee911ce436066205ff5522ecc860d6d6182fd8172e8bbd45d47bff0eea9404979994ef1f3aa5bd
+  data.tar.gz: bafbe8748b9b246aa8eb7153ccac0bea64359263740a25e7555c04a36cea99b25c76ffee1cb3ba7e9112678239772fe7a41584f4587de6bbdda59a3450f5eadd

data/README.md

@@ -1,47 +1,68 @@
-# PackingPeanut
+# ![PackingPeanut Logo](./_art/logo_100.png) PackingPeanut 
 
-iOS has [BubbleWrap](https://github.com/rubymotion/BubbleWrap) for App Persistence : Android has **PackingPeanut**
+iOS has [BubbleWrap](https://github.com/rubymotion/BubbleWrap) for App Persistence : Android has PackingPeanut
 
-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.
+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:
+
+[**GITHUB HOMEPAGE**](http://gantman.github.io/PackingPeanut/)
 
 ## Installation
 
-Add this line to your application's Gemfile:
+**Step 1:** Add this line to your application's Gemfile:
 
     gem 'PackingPeanut'
 
-And then execute:
+**Step 2:** And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install PackingPeanut
-
 ## Usage
 
 Example Usage from REPL
 ```
-# PP automatically has context if the module is included but in this case
-# First we need to set the context when in REPL, 
+# PP automatically has context if the module is included
+# In this case we need to set the context
 $ 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['lunch'] = "tacos"
+$ 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
-$ App::Persistence['dinner']
-=> ""  # empty because we're now in a new storage file.
 
 ```
 
+`App::Persistence` has been Aliasted to `PP::Persistence` for the bold.
+
+## 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.
+
+Memorizable symbols and their corresponding constants:
+```ruby
+    PREFERENCE_MODES = {
+      private: MODE_PRIVATE,
+      readable: MODE_WORLD_READABLE,
+      world_readable: MODE_WORLD_READABLE,
+      writable: MODE_WORLD_WRITEABLE,
+      world_writable: MODE_WORLD_WRITEABLE,
+      multi: MODE_MULTI_PROCESS,
+      multi_process: MODE_MULTI_PROCESS
+    }
+```
+
+## 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.
+
 ## Contributing
 
 1. Fork it

data/lib/project/PackingPeanut.rb

@@ -2,9 +2,14 @@
 # Potential fixes for type specifics
 # Super fix #1 ->   Serialize it: http://stackoverflow.com/questions/7057845/save-arraylist-to-sharedpreferences
 # ObjectSerializer: https://github.com/apache/pig/blob/89c2e8e76c68d0d0abe6a36b4e08ddc56979796f/src/org/apache/pig/impl/util/ObjectSerializer.java
+# https://pig.apache.org/releases.html
 # Super fix #2 ->   Store depending on the class and retrieve with either
 # A: Failover defaults calling methods
 # B: Grab ALL data, and use that hash
+# Super fix #3 ->  Serialize with JSON
+# new Gson().toJson(obj)
+# And for deserialization,
+
 
 module App
   module Persistence
@@ -14,6 +19,8 @@ module App
     MODE_WORLD_WRITEABLE = 2
     MODE_MULTI_PROCESS = 4
 
+    JSONObject = Org::Json::JSONObject
+
     PREFERENCE_MODES = {
       private: MODE_PRIVATE,
       readable: MODE_WORLD_READABLE,
@@ -26,15 +33,29 @@ module App
 
     module_function
 
+    # Serialize key/value as json then
+    # store that string with the settings key == json key
     def []=(key, value)
       settings = get_settings
       editor = settings.edit
-      editor.putString(key, value)
+      json = serialize(key,value)
+      editor.putString(key, json.toString)
       editor.commit 
     end
 
     def [](key)
-      get_value key
+      json_string = get_value(key)
+      deserialize(key, json_string)
+    end
+
+    def serialize(key, value)
+      json = JSONObject.new
+      json.put(key, value)
+    end
+
+    def deserialize(key, json_string)
+      json = JSONObject.new(json_string)
+      json.get(key)
     end
 
     def get_value key
@@ -60,7 +81,7 @@ module App
 
     def all
       settings = get_settings
-      settings.getAll
+      settings.getAll.map { |key, value| {key.to_sym => JSONObject.new(value).get(key)} }
     end
 
     def get_settings

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: PackingPeanut
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Gant
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-12 00:00:00.000000000 Z
+date: 2015-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -34,7 +34,7 @@ files:
 - README.md
 - lib/PackingPeanut.rb
 - lib/project/PackingPeanut.rb
-homepage: https://github.com/GantMan/PackingPeanut
+homepage: http://gantman.github.io/PackingPeanut/
 licenses:
 - MIT
 metadata: {}
@@ -57,5 +57,6 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: App persistent data for RubyMotion Android
+summary: App persistent data for RubyMotion Android, designed to fit the API stylings
+  of the popular iOS Gem BubbleWrap which also supplies persistence.
 test_files: []