motion-ios-simplesplash 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0212c1e187061817d7bfde5cefe746e9dd2cfc01e0217561e1189f279c0188c8
+  data.tar.gz: d3c070943fba0c9514175925b6399f4e86bf067c2457b2cd62952649adbfe412
+SHA512:
+  metadata.gz: abd4a71a18852c60cc8bce6b3c578f1344e16bf00934a1cad5480f6e930c005e63d4cfa447fd56b1ca3b92debcad6a77c0909a72353cf8c79422e2e76028c30b
+  data.tar.gz: efa168da3249ca4effde48273a88f04df3d6b501ce0c823bb2fbb46b828e503f2d051e88de8c876b1ae69880f0efb24e612073ddbf9f73d1e73c61e9c6bf7440

data/README.md

@@ -0,0 +1,59 @@
+# RubyMotion SimpleSplash
+
+Generate a simple splash page to be used in iOS projects, that uses autolayout to fit all devices.
+
+Currently the library will use a default colour definition or you can specify a colour by definition (RGB).
+
+### Background
+
+I needed a quick, brain-dead simple way of adding a splash screen for my iOS projects. I was adding the `ib` gem, generating the storybaord, opening Xcode and then editing it. All to create a fairly simple XML file that really didn't need all of those extra steps.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'motion-ios-simplesplash'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install motion-ios-simplesplash
+
+## Usage
+
+```bash
+ $ bundle exec rake generate:simple_splash
+```
+
+This will generate the file `SimpleSplash.storyboard` in the resources directory of your project. RubyMotion will automatically compile this files and copy it to your application resources. You will need to specify that the storyboard file should be used as the splash screen. This is done by adding the following to your `Rakefile`:
+
+```ruby
+     app.info_plist['UILaunchStoryboardName'] = 'SimpleSplash'
+``` 
+
+You can edit the storyboard file once it has been produced if it is not exactly to your liking. You may or may not need to include the `ib` gem and then open using Xcode. Those of you wanting to get your *XML on* can simply open the storyboard file (it is just and XML text file) and hack. YMMV
+
+The `rake` command above will generate a splash screen with the default background (light gray- Red: 224, Green: 226, Blue: 220). However you can run the command and specify the RGB values to allow you to create a splash screen that matches your application's colour scheme. The values for red, green and blue are in the range 0-255. For example, to create a splash screen with a vibrant yellow background (Red: 255, Green: 255, Blue: 0), execute the following:
+
+```bash
+ $ bundle exec rake generate:simple_splash[255,255,0]
+```
+
+If there is an existing splash screen file, it will be overwritten with the new values. This is helpful, as you can update the splash screen any time you wish. 
+ 
+### Caution
+Rerunning the `rake generate:simple_splash` will replace the current `SimpleSplash.storyboard` file with a freshly generated version. Good if you are recovering from a mistaken edit, not so good if you had changes that you wanted to keep. Make a backup if you have changes you wish to save before re-executing the command.
+
+### Additional Considerations
+For most projects, the motion-ios-simplesplash will be single use. Once you have generated your splash screen you are done. If you wish, you can remove the gem from your `Gemfile` once your splash storyboard has been generated, there are no build or runtime dependencies.
+
+## 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/lib/motion-ios-simplesplash.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+unless defined?(Motion::Project::Config)
+  raise "This file must be required within a RubyMotion project Rakefile."
+end
+
+lib_dir_path = File.dirname(File.expand_path(__FILE__))
+
+require File.join(lib_dir_path, "tasks/motion-ios-simplesplash.rb")

data/lib/tasks/motion-ios-simplesplash.rb

@@ -0,0 +1,154 @@
+require 'builder'
+
+module SimpleSplash
+
+  module Storyboard
+    StoryboardItem = Struct.new(:name, :attributes, :entries) do
+      def to_xml(xml)
+        if attributes && attributes.size > 0
+          if entries && entries.size > 0
+            xml.tag!(name, attributes) do |xml|
+              entries.each do |entry|
+                entry.to_xml(xml)
+              end
+            end
+          else
+            xml.tag!(name, attributes)
+          end
+        else
+          if entries && entries.size > 0
+            xml.tag!(name) do |xml|
+              entries.each do |entry|
+                entry.to_xml(xml)
+              end
+            end
+          else
+            xml.tag!(name)
+          end
+        end
+      end
+    end
+
+    BASE_COLOUR = {name: "backgroundColor", red: 224, green: 226, blue: 220}
+
+    def self.build(vc_id, colours=[])
+      unless colours && colours.size > 0
+        colours = [BASE_COLOUR]
+      end
+      # bg_colour_name = colours[0][:name]
+
+      StoryboardItem.new('document', { type: "com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB",
+                                       version: "3.0", toolsVersion: "14460.31",
+                                       targetRuntime: "iOS.CocoaTouch",
+                                       propertyAccessControl: "none", useAutolayout: "YES",
+                                       useTraitCollections: "YES", useSafeAreas: "YES",
+                                       colorMatched: "YES", initialViewController: vc_id },
+                         [ StoryboardItem.new('device', {id: "retina4_7", orientation: "portrait"},
+                                              [StoryboardItem.new("adaptation", {id: "fullscreen" })]),
+                           StoryboardItem.new('dependencies', nil,
+                                              [StoryboardItem.new("plugIn",
+                                                                  {identifier: "com.apple.InterfaceBuilder.IBCocoaTouchPlugin",
+                                                                   version: "14460.20"
+                                                                  }),
+                                               StoryboardItem.new("capability",
+                                                                  {name: "Safe area layout guides",
+                                                                   minToolsVersion: "9.0"}),
+                                               StoryboardItem.new("capability",
+                                                                  {name: "documents saved in the Xcode 8 format",
+                                                                   minToolsVersion: "8.0"})
+                                              ]),
+                           StoryboardItem.new('scenes', nil,
+                                              [StoryboardItem.new('scene', {sceneID: "S9a-Lo-nRK"},
+                                                                  storyboard_objects(vc_id, colours[0]))]),
+                           # add_color_resources(colours)
+                         ]
+      )
+    end
+
+    def self.storyboard_objects(vc_id, colour)
+      [StoryboardItem.new("objects", nil,
+                          [storyboard_vc(vc_id, colour),
+                           StoryboardItem.new("placeholder",
+                                              {placeholderIdentifier: "IBFirstResponder",
+                                               id: "nbj-SD-Ib0", userLabel: "First Responder",
+                                               sceneMemberID: "firstResponder"})
+                          ]),
+       StoryboardItem.new("point", {key:"canvasLocation", x:"-340", y: "-71"})]
+    end
+
+    def self.storyboard_vc(vc_id, colour)
+      # cap_name = bg_colour_name.clone
+      # cap_name[0] = cap_name.slice(0).upcase
+      StoryboardItem.new("viewController", { id: vc_id, sceneMemberID: "viewController" },
+                         [StoryboardItem.new("view", {key: "view", contentMode: "scaleToFill",
+                                                     id: "Ff1-8D-V8f"},
+                                            [StoryboardItem.new("rect",
+                                                                {key: "frame", x: "0.0", y:"0.0",
+                                                                 width: "375", height: "667"}),
+                                             StoryboardItem.new("autoresizingMask",
+                                                                {key: "autoresizingMask",
+                                                                 widthSizable: "YES",
+                                                                 heightSizable: "YES"}),
+                                             StoryboardItem.new("color",
+                                                                {key: colour[:name]}.
+                                                                    merge(colour_set(colour))),
+                                             StoryboardItem.new("viewLayoutGuide", {key: "safeArea",
+                                                                                    id: "7Wg-de-foW"})
+                                            ])])
+    end
+
+    def self.add_color_resources(colours=[])
+      StoryboardItem.new("resources", nil,
+                         colours.map { |col| generate_colour_item(col) })
+    end
+
+    def self.generate_colour_item(colour)
+      cap_name = colour[:name].clone
+      cap_name[0] = cap_name.slice(0).upcase
+      StoryboardItem.new("namedColor", {name: cap_name},
+                         [StoryboardItem.new("color",
+                                             {key: colour[:name]}.merge(colour_set(colour)))
+                         ])
+    end
+
+    def self.colour_set(colour)
+      {
+          red:   "%.10f" % (colour[:red].to_f / 255.0),
+          green: "%.10f" % (colour[:green].to_f / 255.0),
+          blue:  "%.10f" % (colour[:blue].to_f / 255.0),
+          alpha: "%.3f"  % colour.fetch(:alpha, 1.0),
+          colorSpace: "custom",
+          customColorSpace: "sRGB"
+      }
+    end
+  end
+end
+
+namespace :generate do |ns|
+  desc 'Generate a splash screen with a single colour for iOS applications (in a storyboard file)'
+  task :simple_splash, :red, :green, :blue do |t, args|
+    vc_id = "Ohr-fl-fP5"   # Assign a fixed value, may need to change this in the future
+
+    splash_colour = {name: "backgroundColor",
+                     red: args.fetch(:red, 224),
+                     green: args.fetch(:green, 226),
+                     blue: args.fetch(:blue, 220)}
+    puts "\n\n"
+    if args[:red].nil? && args[:green].nil? && args[:blue].nil?
+      puts "Using the default splash background colour"
+      puts "\n"
+      puts "You can specify your own values by re-executing the command like:"
+      puts "     '$rake generate:simple_splash[<red>,<green>,<blue>]'"
+    else
+      puts "Using an rgb of #{splash_colour[:red]}:#{splash_colour[:green]}:#{splash_colour[:blue]} for the splash background"
+    end
+    output = File.open("resources/SimpleSplash.storyboard", 'w')
+    xml_builder = Builder::XmlMarkup.new(:target=>output, :indent=>2)
+    xml_builder.instruct!
+    SimpleSplash::Storyboard.build(vc_id, [splash_colour]).to_xml(xml_builder)
+    puts "\n\n*************"
+    puts "*Be sure to add: \n\n"
+    puts "       app.info_plist['UILaunchStoryboardName'] = 'SimpleSplash'"
+    puts "\n  to your Rakefile\n\n"
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: motion-ios-simplesplash
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Andy Stechishin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-26 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.2
+description: Generate a simple splash page in a storyboard file for RubyMotion projects
+email:
+- andy@canasoftware.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/motion-ios-simplesplash.rb
+- lib/tasks/motion-ios-simplesplash.rb
+homepage: ''
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Generate a simple splash page in a storyboard file for RubyMotion projects
+test_files: []