android-xml 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 86309a38baac267caea7eea59fde2d5b2212b118
+  data.tar.gz: ac749e5475b16b96a535fa907dbe15b133bda2ea
+SHA512:
+  metadata.gz: a8753e1c48772ebdc4f521c42e4d482a6027e9c51303029d5c5e091a6ce75e6f3417e5f3a84046e8303ce43d6bac2c9e1e8bbb86ae048456e57bbae4354800a4
+  data.tar.gz: 291e6376163cce849152830086d4e975630c2dc1b600f7e64288c3818a476f39a14add0663dfcde58f684da07fcb9711644ba3d4a9f2bc02295ecd642aa5640a

data/README.md

@@ -0,0 +1,127 @@
+AndroidXml
+---------
+
+    gem install android-xml
+
+# Quick start
+
+###### generate_xml.rb
+```ruby
+require 'android-xml'
+
+AndroidXml.file('res/values/strings.xml') do
+  resource do
+    string(name: 'app_name') { 'AppityApp' }
+  end
+end
+
+AndroidXml.write_all
+```
+
+    > ruby generate_xml.rb
+    ✓ res/values/strings.xml
+
+    > cat res/values/strings.xml
+    <?xml version="1.0" encoding="utf-8"?>
+    <!-- Do not edit this file. It was generated by AndroidXml -->
+    <resources>
+        <string name="app_name">AppityApp</string>
+    </resources>
+
+# About
+
+With **AndroidXml** you can generate an XML file with much less fuss.  It will
+take care of prefixing attributes with `android:` when required, it includes the
+`<?xml ?>` tag, includes the `xmlns:` attribute on your root node (but only when
+required)... all that good stuff!
+
+You still need to understand the format that the various Android XML files
+expect, but hopefully you get a good productivity boost.
+
+# More examples
+
+```ruby
+# The dreaded AndroidManifest file!
+AndroidXml.file('AndroidManifest.xml') do
+  manifest package: 'com.your_name_here.AppityApp', versionCode: 1, versionName: 1.0 do
+    uses_sdk minSdkVersion: 11
+
+    application label: '@string/app_name', icon: '@drawable/ic_launcher' do
+      activity name: 'MainActivity', label: '@string/app_name' do
+        intent_filter do
+          # these helpers are defined in `android-xml/defaults.rb`,
+          # and you can easily add your own with an AndroidXml.setup block (see
+          # below)
+          main_action
+          launcher_category
+        end
+      end
+
+      activity name: 'DisplayMessageActivity',
+        label: '@string/app_name',
+        parentActivityName: 'com.your_name_here.AppityApp.MainActivity'
+    end
+  end
+end
+
+# You can generate multiple files from one .rb file
+AndroidXml.file('res/values-jp/strings.xml') do
+  resource do
+    string(name: 'app_name') { 'アッピティアップ' }
+  end
+end
+
+AndroidXml.write_all
+```
+
+# Helpers
+
+Here's how we create the main_action helper, or if you need to specify that some
+attributes don't need the `android:` prefix.
+
+```ruby
+AndroidXml.setup do
+  # the hash syntax specifies the `shortcut => actual-tag-name`
+  tag :main_action => 'action' do
+    # then we can assign default attributes
+    defaults name: 'android.intent.action.MAIN'
+  end
+  tag :style do
+    # <style name="..."> is correct - NOT <style android:name="...">
+    rename :name
+  end
+
+  # if you want to add your own shorthands, go nuts:
+  tag :activity do
+    rename :parent => :parentActivityName
+  end
+
+  # global changes
+  all do
+    rename :style  # always style="", never android:style=""
+  end
+
+  # adds the xmlns attribute to the root node, no matter WHAT the root node is
+  root do
+    defaults 'xmlns:android' => 'http://schemas.android.com/apk/res/android'
+  end
+
+  # disable the xmlns attribute on the resource node
+  tag :resources do
+    defaults 'xmlns:android' => nil
+  end
+end
+```
+
+# Errata
+
+```ruby
+# If you want to check the output before committing to `write_all`
+AndroidXml.output_all
+
+# If you want to wipe out all the defaults and settings
+AndroidXml.reset
+
+# If you want the defaults back
+AndroidXml.setup_defaults
+```

data/lib/android-xml.rb

@@ -0,0 +1,6 @@
+require_relative './android-xml/main'
+require_relative './android-xml/tag'
+require_relative './android-xml/file'
+require_relative './android-xml/defaults'
+
+AndroidXml.setup_defaults

data/lib/android-xml/defaults.rb

@@ -0,0 +1,44 @@
+require 'android-xml'
+
+
+module AndroidXml
+  module_function
+
+  def setup_defaults
+    setup do
+      # assign the xmlns to all root nodes
+      root do
+        defaults 'xmlns:android' => 'http://schemas.android.com/apk/res/android'
+      end
+
+      all do
+        # suppress 'android:' prefix to all style attributes
+        rename :style
+      end
+
+      # disable the xmlns attribute on the resource node
+      tag :resources do
+        defaults 'xmlns:android' => nil
+      end
+
+      # remove the 'android:' prefix
+      tag :string, :style, :item do
+        rename :name
+      end
+      tag :style do
+        rename :parent
+      end
+      tag :manifest do
+        rename :package
+      end
+
+      # creates a couple "tag shortcuts"
+      tag :main_action => 'action' do
+        defaults name: 'android.intent.action.MAIN'
+      end
+      tag :launcher_category => 'category' do
+        defaults name: 'android.intent.category.LAUNCHER'
+      end
+    end
+  end
+end

data/lib/android-xml/file.rb

@@ -0,0 +1,42 @@
+module AndroidXml
+
+  class XmlFile < Tag
+
+    attr :filename
+
+    def initialize(filename, &block)
+      @filename = filename
+      super(nil, &block)
+      AndroidXml.files << self
+    end
+
+    def method_missing(method_name, *args, &block)
+      raise "There can be only one (new: #{method_name}, old: #{@root})" if @root
+
+      @root = super
+      @root.is_root = true
+      @root
+    end
+
+    def generate
+      output = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n"
+      output << "<!-- Do not edit this file. It was generated by AndroidXml -->\n"
+      output << generate_block
+    end
+
+    def out
+      puts "---- filename: #{@filename} ----"
+      super
+      puts "---------------#{'-' * @filename.to_s.length}-----"
+    end
+
+    def write
+      File.open(self.filename, 'w') do |f|
+        f.write(self.to_s)
+      end
+      puts "✓ #{self.filename}"
+    end
+
+  end
+
+end

data/lib/android-xml/main.rb

@@ -0,0 +1,115 @@
+module AndroidXml
+  ROOT = '__root_node_with_a_long_special_name__'
+  ALL = '__all_node_with_a_long_special_name__'
+
+  module_function
+
+  def tab=(value)
+    @tab = value
+  end
+
+  def file(filename, &block)
+    XmlFile.new(filename, &block)
+  end
+
+  def files
+    @files ||= []
+  end
+
+  def write_all
+    files.each do |xml_file|
+      xml_file.write
+    end
+
+    @files = nil
+  end
+
+  def output_all
+    files.each do |xml_file|
+      xml_file.out
+      puts
+    end
+  end
+
+  def diff_all
+    files.each do |xml_file|
+    end
+  end
+
+  def tags
+    @tags ||= Hash.new do |hash, key|
+      hash[key] = {
+        attrs: {},
+        defaults: {},
+        rename: nil,
+      }
+    end
+  end
+
+  def tab
+    @tab ||= '    '
+  end
+
+  def reset
+    @tab = nil
+    @tags = nil
+    @files = nil
+  end
+
+  def setup(&block)
+    instance_exec(&block)
+  end
+
+  def root_tag
+    tags[ROOT]
+  end
+
+  def root(&block)
+    tag(ROOT, &block)
+  end
+
+  def all_tag
+    tags[ALL]
+  end
+
+  def all(&block)
+    tag(ALL, &block)
+  end
+
+  def tag(*names, &block)
+    context_was = @context
+
+    names.each do |name|
+      if name.is_a?(Hash)
+        @context = nil
+        name.each do |shortcut, tag_name|
+          raise "There can be only one key-value pair" if @context
+
+          @context = shortcut.to_s
+          tags[@context][:rename] = tag_name.to_s
+        end
+      else
+        @context = name.to_s
+      end
+
+      instance_exec(&block)
+    end
+
+    @context = context_was
+  end
+
+  def rename(attrs)
+    if attrs.is_a?(Hash)
+      attrs.each do |attr_name, attr_rename|
+        tags[@context][:attrs][attr_name.to_s] = attr_rename.to_s
+      end
+    else
+      tags[@context][:attrs][attrs.to_s] = attrs.to_s
+    end
+  end
+
+  def defaults(attrs)
+    tags[@context][:defaults].merge!(attrs)
+  end
+
+end

data/lib/android-xml/tag.rb

@@ -0,0 +1,132 @@
+module AndroidXml
+
+  class Tag
+    attr_accessor :is_root
+
+    def initialize(tag, *args, &block)
+      @buffer = []
+      @attrs = {}
+      @raw_tag = tag.to_s
+      @text = nil
+
+      if rename = AndroidXml.tags[tag.to_s][:rename]
+        @tag = rename
+      else
+        @tag = tag.to_s.gsub('_', '-')
+      end
+
+      args.each do |arg|
+        if arg.is_a?(Hash)
+          @attrs.merge!(arg)
+        elsif arg.is_a?(String)
+          @text = arg
+        else
+          raise ArgumentError.new("Unknown argument #{arg.inspect} in #{self.class}#new")
+        end
+      end
+
+      @generate = block
+    end
+
+    def method_missing(method_name, *args, &block)
+      tag = Tag.new(method_name, *args, &block)
+      @buffer << tag
+      tag
+    end
+
+    def attrs(whitespace)
+      attrs = {}
+
+      attrs.merge!(AndroidXml.all_tag[:defaults])
+      if is_root
+        attrs.merge!(AndroidXml.root_tag[:defaults])
+      end
+
+      attrs.merge!(AndroidXml.tags[@raw_tag][:defaults])
+      attrs.merge!(@attrs)
+
+      output = ''
+      is_first = true
+      attrs.each do |key, value|
+        next if value.nil?
+
+        key = key.to_s
+
+        if AndroidXml.tags[@tag][:attrs].key?(key)
+          xml_key = AndroidXml.tags[@tag][:attrs][key]
+        elsif AndroidXml.all_tag[:attrs].key?(key)
+          xml_key = AndroidXml.all_tag[:attrs][key]
+        elsif key.to_s.include?(':')
+          xml_key = key.to_s
+        else
+          xml_key = "android:#{key}"
+        end
+
+        if is_first
+          output << " #{xml_key}=\"#{value}\""
+          is_first = false
+        else
+          output << "\n#{whitespace}#{xml_key}=\"#{value}\""
+        end
+      end
+      output
+    end
+
+    def generate(tab='')
+      whitespace = "#{tab}  #{' ' * @tag.length}"
+      output = "#{tab}<#{@tag}#{attrs(whitespace)}"
+      if @generate
+        inside = generate_block(tab + AndroidXml.tab)
+        if !inside || inside.strip.empty?
+          output << " />\n"
+        else
+          output << ">"
+          if inside.lstrip.start_with?('<')
+            output << "\n" << inside << "#{tab}</#{@tag}>\n"
+          else
+            output << inside << "</#{@tag}>\n"
+          end
+        end
+      else
+        output << " />\n"
+      end
+
+      output
+    end
+
+    def generate_block(tab='')
+      return @block_output if @block_output
+
+      output = ''
+      if @generate
+        text = instance_exec(&@generate)
+        @buffer.each do |tag|
+          output << tag.generate(tab)
+        end
+        if text.is_a?(String)
+          if output.empty?
+            output << text
+          else
+            output << tab << text << "\n"
+          end
+        end
+      end
+
+      @block_output = output
+    end
+
+    def to_s
+      generate
+    end
+
+    def to_ary
+      [to_s]
+    end
+
+    def out
+      puts to_s
+    end
+
+  end
+
+end

data/lib/android-xml/version.rb

@@ -0,0 +1,3 @@
+module AndroidXml
+  Version = '1.0.0'
+end

data/spec/android_manifest_spec.rb

@@ -0,0 +1,55 @@
+require 'android-xml'
+
+
+describe 'AndroidManifest.xml' do
+
+  before do
+    AndroidXml.reset
+    AndroidXml.setup_defaults
+  end
+
+  it 'should generate a sensible AndroidManifest file' do
+    xml = AndroidXml.file('AndroidManifest.xml') do
+      manifest package: 'com.your_name_here.AnyAndroidApp', versionCode: 1, versionName: 1.0 do
+        uses_sdk minSdkVersion: 11
+
+        application label: '@string/app_name', icon: '@drawable/ic_launcher' do
+          activity name: 'MainActivity', label: '@string/app_name' do
+            intent_filter do
+              main_action
+              launcher_category
+            end
+          end
+
+          activity name: 'AnotherActivity', label: '@string/app_name', parentActivityName: 'com.your_name_here.AnyAndroidApp.MainActivity'
+        end
+      end
+    end
+
+    expect(xml.to_s).to eql <<-XML
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Do not edit this file. It was generated by AndroidXml -->
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+          package="com.your_name_here.AnyAndroidApp"
+          android:versionCode="1"
+          android:versionName="1.0">
+    <uses-sdk android:minSdkVersion="11" />
+    <application android:label="@string/app_name"
+                 android:icon="@drawable/ic_launcher">
+        <activity android:name="MainActivity"
+                  android:label="@string/app_name">
+            <intent-filter>
+                <action android:name="android.intent.action.MAIN" />
+                <category android:name="android.intent.category.LAUNCHER" />
+            </intent-filter>
+        </activity>
+        <activity android:name="AnotherActivity"
+                  android:label="@string/app_name"
+                  android:parentActivityName="com.your_name_here.AnyAndroidApp.MainActivity" />
+    </application>
+</manifest>
+XML
+
+  end
+
+end

data/spec/android_menu_spec.rb

@@ -0,0 +1,70 @@
+require 'android-xml'
+
+
+describe 'Android menu files' do
+
+  before do
+    AndroidXml.reset
+    AndroidXml.setup_defaults
+  end
+
+  it 'should generate a sensible menu.xml file' do
+    xml = AndroidXml.file('res/menu/menu.xml') do
+      menu do
+        item id: '@+id/action_search',
+          icon: '@drawable/ic_action_search',
+          title: '@string/action_search',
+          showAsAction: 'ifRoom'
+
+        item id: '@+id/action_settings',
+          title: '@string/action_settings',
+          showAsAction: 'never'
+      end
+    end
+
+    expect(xml.to_s).to eql <<-XML
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Do not edit this file. It was generated by AndroidXml -->
+<menu xmlns:android="http://schemas.android.com/apk/res/android">
+    <item android:id="@+id/action_search"
+          android:icon="@drawable/ic_action_search"
+          android:title="@string/action_search"
+          android:showAsAction="ifRoom" />
+    <item android:id="@+id/action_settings"
+          android:title="@string/action_settings"
+          android:showAsAction="never" />
+</menu>
+XML
+  end
+
+  it 'should generate a sensible strings.xml file' do
+    xml = AndroidXml.file('res/values/strings.xml') do
+      resources do
+        string(name: 'app_name') { 'Harroo' }
+        string(name: 'hello') { 'Well, Harroo!' }
+        string(name: 'portrait') { 'portrait' }
+        string(name: 'landscape') { 'landscape' }
+        string(name: 'button_send') { 'Send' }
+        string(name: 'action_search') { 'Search' }
+        string(name: 'action_settings') { 'Settings' }
+        string(name: 'title_activity_main') { 'MainActivity' }
+      end
+    end
+
+    expect(xml.to_s).to eql <<-XML
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Do not edit this file. It was generated by AndroidXml -->
+<resources>
+    <string name="app_name">Harroo</string>
+    <string name="hello">Well, Harroo!</string>
+    <string name="portrait">portrait</string>
+    <string name="landscape">landscape</string>
+    <string name="button_send">Send</string>
+    <string name="action_search">Search</string>
+    <string name="action_settings">Settings</string>
+    <string name="title_activity_main">MainActivity</string>
+</resources>
+XML
+  end
+
+end

data/spec/android_resources_spec.rb

@@ -0,0 +1,68 @@
+require 'android-xml'
+
+
+describe 'Android resource files' do
+
+  before do
+    AndroidXml.reset
+    AndroidXml.setup_defaults
+  end
+
+  it 'should generate a sensible style.xml file' do
+    xml = AndroidXml.file('res/values/style.xml') do
+      resources do
+        style(name: 'CodeFont', parent: '@android:style/TextAppearance.Medium') do
+          item(name: "android:layout_width") { 'fill_parent' }
+          item(name: "android:layout_height") { 'wrap_content' }
+          item(name: "android:textColor") { '#00FF00' }
+          item(name: "android:typeface") { 'monospace' }
+        end
+      end
+    end
+
+    expect(xml.to_s).to eql <<-XML
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Do not edit this file. It was generated by AndroidXml -->
+<resources>
+    <style name="CodeFont"
+           parent="@android:style/TextAppearance.Medium">
+        <item name="android:layout_width">fill_parent</item>
+        <item name="android:layout_height">wrap_content</item>
+        <item name="android:textColor">#00FF00</item>
+        <item name="android:typeface">monospace</item>
+    </style>
+</resources>
+XML
+  end
+
+  it 'should generate a sensible strings.xml file' do
+    xml = AndroidXml.file('res/values/strings.xml') do
+      resources do
+        string(name: 'app_name') { 'Harroo' }
+        string(name: 'hello') { 'Well, Harroo!' }
+        string(name: 'portrait') { 'portrait' }
+        string(name: 'landscape') { 'landscape' }
+        string(name: 'button_send') { 'Send' }
+        string(name: 'action_search') { 'Search' }
+        string(name: 'action_settings') { 'Settings' }
+        string(name: 'title_activity_main') { 'MainActivity' }
+      end
+    end
+
+    expect(xml.to_s).to eql <<-XML
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Do not edit this file. It was generated by AndroidXml -->
+<resources>
+    <string name="app_name">Harroo</string>
+    <string name="hello">Well, Harroo!</string>
+    <string name="portrait">portrait</string>
+    <string name="landscape">landscape</string>
+    <string name="button_send">Send</string>
+    <string name="action_search">Search</string>
+    <string name="action_settings">Settings</string>
+    <string name="title_activity_main">MainActivity</string>
+</resources>
+XML
+  end
+
+end

data/spec/generate_spec.rb

@@ -0,0 +1,124 @@
+require 'android-xml'
+
+describe AndroidXml do
+
+  before do
+    AndroidXml.reset
+  end
+
+  it 'should generate <any-tag />' do
+    xml = AndroidXml.file('tmp/test.xml') do
+      any_tag
+    end
+
+    expect(xml.to_s).to eql <<-XML
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Do not edit this file. It was generated by AndroidXml -->
+<any-tag />
+XML
+  end
+
+  it 'should generate <any-tag with="properties" />' do
+    xml = AndroidXml.file('tmp/test.xml') do
+      any_tag with: 'properties'
+    end
+
+    expect(xml.to_s).to eql <<-XML
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Do not edit this file. It was generated by AndroidXml -->
+<any-tag android:with="properties" />
+XML
+  end
+
+  it 'should generate <any-tag>with text</any-tag>' do
+    xml = AndroidXml.file('tmp/test.xml') do
+      any_tag { 'with text' }
+    end
+
+    expect(xml.to_s).to eql <<-XML
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Do not edit this file. It was generated by AndroidXml -->
+<any-tag>with text</any-tag>
+XML
+  end
+
+  it 'should generate <nested><tags /></nested>' do
+    xml = AndroidXml.file('tmp/test.xml') do
+      nested do
+        tags
+        tags
+        tags
+      end
+    end
+
+    expect(xml.to_s).to eql <<-XML
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Do not edit this file. It was generated by AndroidXml -->
+<nested>
+    <tags />
+    <tags />
+    <tags />
+</nested>
+XML
+  end
+
+  it 'should generate <nested><tags /></nested> with custom whitespace' do
+    xml = AndroidXml.file('tmp/test.xml') do
+      nested do
+        tags
+        tags
+        tags
+      end
+    end
+    AndroidXml.tab = '  '
+
+    expect(xml.to_s).to eql <<-XML
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Do not edit this file. It was generated by AndroidXml -->
+<nested>
+  <tags />
+  <tags />
+  <tags />
+</nested>
+XML
+  end
+
+  it 'should generate <nested><tags />with text</nested>' do
+    xml = AndroidXml.file('tmp/test.xml') do
+      nested do
+        tags
+        tags
+        'with text'
+      end
+    end
+
+    expect(xml.to_s).to eql <<-XML
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Do not edit this file. It was generated by AndroidXml -->
+<nested>
+    <tags />
+    <tags />
+    with text
+</nested>
+XML
+  end
+
+  it 'should generate <nested with="" many="properties"><tags with="" many="properties" /></nested>' do
+    xml = AndroidXml.file('tmp/test.xml') do
+      nested with: '', many: 'properties' do
+        tags with: '', many: 'properties'
+      end
+    end
+
+    expect(xml.to_s).to eql <<-XML
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Do not edit this file. It was generated by AndroidXml -->
+<nested android:with=""
+        android:many="properties">
+    <tags android:with=""
+          android:many="properties" />
+</nested>
+XML
+  end
+
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: android-xml
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Colin T.A. Gray
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: |
+  Add this to your build process, and never write XML again!
+
+  Plus, you can have multiple files generated from one file.
+email:
+- colinta@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/android-xml/defaults.rb
+- lib/android-xml/file.rb
+- lib/android-xml/main.rb
+- lib/android-xml/tag.rb
+- lib/android-xml/version.rb
+- lib/android-xml.rb
+- README.md
+- spec/android_manifest_spec.rb
+- spec/android_menu_spec.rb
+- spec/android_resources_spec.rb
+- spec/generate_spec.rb
+homepage: https://github.com/colinta/android-xml
+licenses:
+- BSD
+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: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Generates Android XML files.
+test_files:
+- spec/android_manifest_spec.rb
+- spec/android_menu_spec.rb
+- spec/android_resources_spec.rb
+- spec/generate_spec.rb