PackingPeanut 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2f04de5df63f75fb232e267e56ce3f33bc0eefb
-  data.tar.gz: 9ad3ba2c1db95ad649252daa5a85c7c786d12419
+  metadata.gz: 12ff5130d11697ea17d75fb51296fc420846c8b7
+  data.tar.gz: 87951bc7c2fb7f9182531bba0594ecaff8173ad1
 SHA512:
-  metadata.gz: 6fc18eab2b1d752c17d3c8f78df711e4f53fe66ecdf8bb94940b457c8d8be0adbfe857eda9822b69b526857cc3d90c9b21f831e57bb46ea312b4a14b8812c001
-  data.tar.gz: b752f132729c59c907d92b1f075bcff4aee493cfe8a35b519303c3a59c190612f2cfc3650204602209d777faec73722f181c04cb29c567e8e9129468d23c76a3
+  metadata.gz: 94326ee0e5896786cfeb0b73b9ab7426b47ee73a36391d1c435e543db1fb289b13e1787c4a17a743dec1f5368d55e5b3a83b2a5b8a451c1cea0f831a240b5cd2
+  data.tar.gz: 7e8fdc3f22364045d489abedcbfea00a5d0a13c38000a10260d3db441da6382bed2097e071607bfc300e2e881b3de86c8a6e2e8ac88f9965980737d2f0d1181c

data/README.md

@@ -32,9 +32,9 @@ App::Persistence[:foo] = true
 ```
 
 Whirlwind Tour via the REPL
-```
+```ruby
 # ONLY ANDROID REQUIRES CONTEXT!
-# Set the context (required in the REPL or when not including the module).
+# See the section on Android context for more info
 $ App::Persistence.context = self
 => #<MainActivity:0x1d20058e>
 $ App::Persistence['dinner'] = "nachos"
@@ -48,11 +48,19 @@ $ App::Persistence.all
 $ App::Persistence.storage_file = "some_new_file"
 => "some_new_file"
 $ App::Persistence['dinner']
-=> ""  # empty because we're now outside the default storage file.
+=> nil  # empty because we're now outside the default storage file.
+```
 
+Friendly aliases:
+```ruby
 # You can use PP instead of App::Persistence if you like
 $ PP['some_boolean'] = true
+# You can use PackingPeanut (true name) if you like
+$ PackingPeanut['so_easy'] = true
+```
 
+Access deeper features:
+```ruby
 # On Android you can set prefrence_modes for cross/app communication
 $ App::Persistence.preference_mode = :world_readable
 => :world_readable
@@ -85,6 +93,29 @@ Adding [Darin's moran gem](https://github.com/darinwilson/moran) allowed seriali
   * **iOS:** Yup!
   * **Android:** Boy that would be nice wouldn't it?
 
+## PackingPeanut Alongside Bubblewrap on iOS?
+It's meant to look just like BubbleWrap, not fight with it.   If you include the BubbleWrap library, PackingPeanut will gracefully bow out of the App::Persistence namespace.  You can still access PackingPeanut with `PP` or `PackingPeanut`.
+
+## Explain this Android `context` _thing_ Again
+Just like a conversation taken out of context can be confusing, Android has a lot of moving parts and requires just about EVERYTHING that would be a lib component to understand the context.   When accessing persistent data, context is required.   You can easily handle this by giving PackingPeanut your application context in your Application startup file.
+
+PackingPeanut Context Examples:
+```ruby
+# Providing Context - Regular
+class MyApplication < Android::App::Application
+  def onCreate
+    PP.context = self
+  end
+end
+
+# Providing Context with BluePotion
+class MyApplication < PMApplication
+  def on_create
+    PP.context = self
+  end
+end
+```
+
 ## Contributing
 
 1. Fork it

data/lib/PackingPeanut-android/PackingPeanut.rb

@@ -1,105 +1,110 @@
-module App
-  module Persistence
-
-    MODE_PRIVATE = 0
-    MODE_WORLD_READABLE = 1
-    MODE_WORLD_WRITEABLE = 2
-    MODE_MULTI_PROCESS = 4
-
-    JSONObject = Org::Json::JSONObject
-
-    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
-    }
-
-    module_function
-
-    # 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(string_key,value)
-      editor.putString(string_key, json.toString)
-      editor.commit
-    end
-
-    def [](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(string_key, json_string)
-    end
+module PackingPeanut
+
+  MODE_PRIVATE = 0
+  MODE_WORLD_READABLE = 1
+  MODE_WORLD_WRITEABLE = 2
+  MODE_MULTI_PROCESS = 4
+
+  JSONObject = Org::Json::JSONObject
+
+  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
+  }
+
+  module_function
+
+  # 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(string_key,value)
+    editor.putString(string_key, json.toString)
+    editor.commit
+  end
 
-    def serialize(key, value)
-      Moran.generate({:"#{key}" => value})
-    end
+  def [](key)
+    # Let's play nice with strings and non-strings
+    string_key = key.to_s
+    json_string = get_value(string_key)
+    return nil if json_string == ""
+    deserialize(string_key, json_string)
+  end
 
-    def deserialize(key, json_string)
-      Moran.parse(json_string)[key]
-    end
+  def serialize(key, value)
+    Moran.generate({:"#{key}" => value})
+  end
 
-    def get_value key
-      settings = get_settings
-      settings.getString(key,nil)
-    end
+  def deserialize(key, json_string)
+    Moran.parse(json_string)[key]
+  end
 
-    def storage_file=(value)
-      @persistence_storage_file = value
-    end
+  def get_value key
+    settings = get_settings
+    settings.getString(key,nil)
+  end
 
-    def storage_file
-      @persistence_storage_file ||= "default_persistence_file"
-    end
+  def storage_file=(value)
+    @persistence_storage_file = value
+  end
 
-    def preference_mode=(value)
-      @current_preference_mode = PREFERENCE_MODES[value] || value
-    end
+  def storage_file
+    @persistence_storage_file ||= "default_persistence_file"
+  end
 
-    def preference_mode
-      @current_preference_mode ||= MODE_PRIVATE
-    end
+  def preference_mode=(value)
+    @current_preference_mode = PREFERENCE_MODES[value] || value
+  end
 
-    def all
-      settings = get_settings
-      all_hashes = settings.getAll.map { |key, value| Moran.parse(value) }
+  def preference_mode
+    @current_preference_mode ||= MODE_PRIVATE
+  end
 
-      # 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
+  def all
+    settings = get_settings
+    all_hashes = settings.getAll.map { |key, value| Moran.parse(value) }
 
-      merged_hashes
+    # 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
 
-    def get_settings
-      current_context.getSharedPreferences(storage_file, preference_mode)
-    end
+    merged_hashes
+  end
 
-    # 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
+  def get_settings
+    raise "[PackingPeanut] Fatal Error - You must set the context before accessing persistent data." unless @context
+    current_context.getSharedPreferences(storage_file, preference_mode)
+  end
 
-    # attr_accessor is not supported for modules in RMAndroid... yet.
-    def context= supplied_context
-      @context = supplied_context
-    end
+  # 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
+    # THIS SHOULD HAVE SAFE FAILOVERS
+    # BUT defined? is causing erros in RMA native methods as of this commit
+    @context
+  end
 
+  # attr_accessor is not supported for modules in RMAndroid... yet.
+  def context= supplied_context
+    @context = supplied_context
   end
+
 end
 
-# delicious shortcut
-PP = App::Persistence unless defined? PP
+# delicious PP shortcut
+PP = PackingPeanut unless defined? PP
+
+# Bubblewrap syntax
+module App
+  Persistence = PackingPeanut unless defined? App::Persistence
+end

data/lib/PackingPeanut-ios/PackingPeanut.rb

@@ -1,68 +1,71 @@
 # Persistence module built on top of NSUserDefaults
-module App
-  module Persistence
-    module_function
+module PackingPeanut
+  module_function
 
-    def app_key
-      @app_key ||= NSBundle.mainBundle.bundleIdentifier
-    end
+  def app_key
+    @app_key ||= NSBundle.mainBundle.bundleIdentifier
+  end
 
-    def storage_file
-      @persistence_storage_file ||= "default_persistence_file"
-    end
+  def storage_file
+    @persistence_storage_file ||= "default_persistence_file"
+  end
 
-    def storage_file=(value)
-      @persistence_storage_file = value
-    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.setObject(value, forKey: storage_key(key))
+    storage.synchronize
+  end
 
-    def [](key)
-      value = storage.objectForKey storage_key(key)
+  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
+    # 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
+  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 delete(key)
+    value = storage.objectForKey storage_key(key)
+    storage.removeObjectForKey(storage_key(key))
+    storage.synchronize
+    value
+  end
 
-    def storage
-      NSUserDefaults.standardUserDefaults
-    end
+  def storage
+    NSUserDefaults.standardUserDefaults
+  end
 
-    def storage_key(key)
-      "#{app_key}_#{storage_file}_#{key}"
-    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
+  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
 
-# delicious shortcut
-PP = App::Persistence unless defined? PP
+
+# delicious PP shortcut
+PP = PackingPeanut unless defined? PP
+
+# Bubblewrap syntax
+module App
+  Persistence = PackingPeanut unless defined? App::Persistence
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: PackingPeanut
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Gant
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-09 00:00:00.000000000 Z
+date: 2015-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake