motion-settings-bundle 0.0.1

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
+MotionSettingsTest

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012, Nick Quaranto
+
+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,87 @@
+# motion-settings-bundle
+
+Create a Settings.bundle for your RubyMotion app. This allows your app to have a "global" settings entry in the Settings app.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'motion-settings-bundle'
+
+And then execute:
+
+    bundle
+
+Or install it yourself as:
+
+    gem install motion-settings-bundle
+
+## Usage
+
+Add a chunk of code into your project's `Rakefile` like so:
+
+``` ruby
+require 'motion-settings-bundle'
+
+Motion::SettingsBundle.setup do |bundle|
+  # A text field. Allows configuration of a string.
+  bundle.text "Name", key: "username", default: "Paul Atreides"
+
+  # A read-only text field. Use for showing a small chunk of text, maybe a version number
+  bundle.title "Year of Birth", key: "yearOfBirth", default: "10,175 AG"
+
+  # An on/off switch. Turn something on or off. Default is `false` (off).
+  bundle.toggle "Kwisatz Haderach?", key: "superpowersEnabled", default: true
+
+  # A slider, configure volume or something linear
+  bundle.slider "Spice Level", key: "spiceLevel", default: 50, min: 1, max: 100
+
+  # Jump to a screen and choose from a list of options
+  bundle.options "Occupation", key: "occupation" do |group|
+    group.option "Padishah Emperor"
+    group.option "Mentat", default: true
+    group.option "Duke of House Atreides"
+  end
+end
+```
+
+Now just run `rake` as normal!
+
+This should now add a `Settings.bundle` folder into your `resources` directory. Make sure to commit it! If you ever change the data in the `Settings.setup` block, it will be re-built on the next `rake` run. You'll end up with something like this:
+
+![screenshot of motion-settings-bundle](https://raw.github.com/qrush/motion-settings-bundle/master/screenshot.png)
+
+If you're wondering how to access this in code, it's pretty easy:
+
+``` ruby
+NSUserDefaults.standardUserDefaults["username"]
+# returns "Paul Atreides"
+```
+
+And so on. Just remember, the defaults aren't populated until your user actually opens the Settings app, so make sure to handle all of your setting entries being `nil`.
+
+## TODO
+
+This project really solely exists to avoid creating/editing the Settings.bundle in XCode. The specs for it so far have been based off [mordaroso/rubymotion-settings-bundle](https://github/mordaroso/rubymotion-settings-bundle). Please feel free to contribute more ways to generate settings!
+
+* Make `options` entry work
+* Add a big chunk of text, like licensing info
+* Add a custom label, "Settings for Blah"
+* Don't re-create files every time
+* Slider default level doesn't seem to work yet
+
+## Contributing
+
+I couldn't figure out how to test this automatically. Run `bundle` to get the gems you need, and then `rake` to generate a RubyMotion app in the iOS simulator, and then open the Settings app.
+
+If you've added a setting it would be really nice if you could update `screenshot.png` as well!
+
+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
+
+## License
+
+MIT. See `LICENSE`.

data/Rakefile

@@ -0,0 +1,55 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+desc "Test by generating an app"
+task :default do
+  dir = "MotionSettingsTest"
+  `rm -rf #{dir}`
+  `motion create #{dir}`
+  Dir.chdir(dir) do
+    File.open("Gemfile", "w") do |f|
+      f.write <<-EOF
+        source :rubygems
+        gem "motion-settings-bundle", :path => ".."
+      EOF
+    end
+
+    `bundle --local`
+
+    File.open("Rakefile", "a") do |f|
+      f.write <<-EOF
+
+require 'bundler'
+Bundler.setup
+
+require 'motion-settings-bundle'
+
+Motion::SettingsBundle.setup do |app|
+  # A text field. Allows configuration of a string.
+  app.text "Name", key: "username", default: "Paul Atreides"
+
+  # A read-only text field. Use for showing a small chunk of text, maybe a version number
+  app.title "Year of Birth", key: "yearOfBirth", default: "10,175 AG"
+
+  # An on/off switch. Turn something on or off. Default is `false` (off).
+  app.toggle "Kwisatz Haderach?", key: "superpowersEnabled", default: true
+
+  # A slider, configure volume or something linear
+  app.slider "Spice Level", key: "spiceLevel", default: 50, min: 1, max: 100
+
+  # Jump to a screen and choose from a list of options
+  app.options "Occupation", key: "occupation" do |group|
+    group.option "Padishah Emperor"
+    group.option "Mentat", default: true
+    group.option "Duke of House Atreides"
+  end
+end
+      EOF
+    end
+
+    puts "*" * 80
+    puts "Booting up the simulator! Jump to the Settings app once booted and open '#{dir}'."
+    puts "*" * 80
+    sh "rake"
+  end
+end

data/lib/motion-settings-bundle.rb

@@ -0,0 +1,34 @@
+unless defined?(Motion::Project::Config)
+  raise "This file must be required within a RubyMotion project Rakefile."
+end
+
+require "fileutils"
+
+require "plist"
+
+require "motion-settings-bundle/configuration"
+require "motion-settings-bundle/generator"
+require "motion-settings-bundle/version"
+
+module Motion
+  module SettingsBundle
+    class << self
+      attr_accessor :generator
+
+      def setup(&block)
+        generator.configure(Configuration.new(&block))
+      end
+    end
+
+    self.generator = Generator.new(App.config.resources_dir)
+  end
+end
+
+desc "Generate a Settings.bundle"
+task :settings do
+  Motion::SettingsBundle.generator.generate
+end
+
+%w(build:simulator build:device).each do |build_task|
+  Rake::Task[build_task].enhance([:settings])
+end

data/lib/motion-settings-bundle/configuration.rb

@@ -0,0 +1,48 @@
+module Motion
+  module SettingsBundle
+    class Configuration
+      attr_reader :preferences
+
+      def initialize(&block)
+        @preferences = []
+        block.call(self)
+      end
+
+      def text(title, options = {})
+        preference(title, "PSTextFieldSpecifier", options, {
+          "IsSecure"               => false,
+          "KeyboardType"           => "Alphabet",
+          "AutoCapitalizationType" => "Sentences",
+          "AutocorrectionType"     => "Default"
+        })
+      end
+
+      def title(title, options = {})
+        preference(title, "PSTitleValueSpecifier", options)
+      end
+
+      def toggle(title, options = {})
+        preference(title, "PSToggleSwitchSpecifier", options, {
+          "TrueValue"  => true,
+          "FalseValue" => false
+        })
+      end
+
+      def slider(title, options = {})
+        preference(title, "PSSliderSpecifier", options, {
+          "MinimumValue" => options[:min],
+          "MaximumValue" => options[:max]
+        })
+      end
+
+      def options(title, options = {})
+      end
+
+      private
+
+      def preference(title, type, options, extras = {})
+        @preferences << {"Title" => title, "Key" => options[:key], "DefaultValue" => options[:default], "Type" => type}.merge(extras)
+      end
+    end
+  end
+end

data/lib/motion-settings-bundle/generator.rb

@@ -0,0 +1,60 @@
+module Motion
+  module SettingsBundle
+    class Generator
+      def initialize(resources_dir)
+        @root_path = File.join(resources_dir, "Settings.bundle")
+      end
+
+      def configure(configuration)
+        @configuration = configuration
+      end
+
+      def generate
+        directory @root_path
+
+        strings_path = File.join(@root_path, "en.lproj")
+        directory strings_path
+
+        strings_file_path = File.join(strings_path, "Root.strings")
+        file strings_file_path do |file|
+          file.write <<-EOF
+/* A single strings file, whose title is specified in your preferences schema. The strings files provide the localized content to display to the user for each of your preferences. */
+
+"Group" = "Group";
+"Name" = "Name";
+"none given" = "none given";
+"Enabled" = "Enabled";
+EOF
+        end
+
+        plist_file_path = File.join(@root_path, "Root.plist")
+
+        file(plist_file_path, true) do |file|
+          file.write({
+            "Title"                => "Settings",
+            "StringsTable"         => "Root",
+            "PreferenceSpecifiers" => @configuration.preferences
+          }.to_plist)
+        end
+      end
+
+      private
+
+      def directory(path)
+        unless File.exist?(path)
+          FileUtils.mkdir(path)
+          App.info "Create", path
+        end
+      end
+
+      def file(path, force = false)
+        if force || !File.exist?(path)
+          File.open(path, "w") do |file|
+            yield file
+          end
+          App.info "Create", path
+        end
+      end
+    end
+  end
+end

data/lib/motion-settings-bundle/version.rb

@@ -0,0 +1,5 @@
+module Motion
+  module SettingsBundle
+    VERSION = "0.0.1"
+  end
+end

data/motion-settings-bundle.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/motion-settings-bundle/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Nick Quaranto"]
+  gem.email         = ["nick@quaran.to"]
+  gem.summary = gem.description =
+   %{Create a Settings.bundle for your RubyMotion app. This allows your app to have a "global" settings entry in the Settings app.}
+  gem.homepage      = "https://github.com/qrush/motion-settings-bundle"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "motion-settings-bundle"
+  gem.require_paths = ["lib"]
+  gem.version       = Motion::SettingsBundle::VERSION
+
+  gem.add_dependency 'plist', '~> 3.1.0'
+  gem.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: motion-settings-bundle
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nick Quaranto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: plist
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Create a Settings.bundle for your RubyMotion app. This allows your app
+  to have a "global" settings entry in the Settings app.
+email:
+- nick@quaran.to
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/motion-settings-bundle.rb
+- lib/motion-settings-bundle/configuration.rb
+- lib/motion-settings-bundle/generator.rb
+- lib/motion-settings-bundle/version.rb
+- motion-settings-bundle.gemspec
+- screenshot.png
+homepage: https://github.com/qrush/motion-settings-bundle
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Create a Settings.bundle for your RubyMotion app. This allows your app to
+  have a "global" settings entry in the Settings app.
+test_files: []
+has_rdoc: