android_string_resources_validator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d59bc83f942aee4719a1fb7759933474ff8520f9
+  data.tar.gz: 3067cf6c925a63c0b84a76de598b7d6f2b2bd083
+SHA512:
+  metadata.gz: 3ef20a5ab64d8a12ce49ae170a83c5612fa2144688324a782bd583ef0b5d3b3f3b9ff20e844ba942983a6842cebdf0e08f71e3853a19f9f9bf483719848a6e6c
+  data.tar.gz: 96f1bbe43aa23a8911e9ab89ab6c2433030593554643c8a743df36b42ee758cf7acd7985b4a1c9345ecdc02fffa758997d4f1b86ba104142381190bb6e7223f9

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Karl Eklund
+
+MIT License
+
+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,51 @@
+# AndroidStringResourcesValidator
+
+[![Circle CI](https://circleci.com/gh/magplus/android_string_resources_validator.png?circle-token=4ad6dc72948c7f0cdc31b92cf292142d599be4ce)](https://circleci.com/gh/magplus/android_string_resources_validator.png?circle-token=4ad6dc72948c7f0cdc31b92cf292142d599be4ce)
+
+Validates an Android strings.xml resource file against the specification at
+http://developer.android.com/guide/topics/resources/string-resource.html
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'android_string_resources_validator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install android_string_resources_validator
+
+## Usage
+
+```ruby
+strings_xml = %q{<resources><string name="hello">It\'s all right</string></resources>}
+validator = AndroidStringResourcesValidator.new(strings_xml)
+validator.valid? # => true
+
+strings_xml = %q{<resources><string name="hello">It's no good</string></resources>}
+validator = AndroidStringResourcesValidator.new(strings_xml)
+validator.valid? # => false
+validator.errors # => ["Apostrophes must be escaped"]
+
+strings_xml = %q{<foo><string name="string_name">text_string</string></foo>}
+validator = AndroidStringResourcesValidator.new(strings_xml)
+validator.valid? # => false
+validator.errors # => ["Not a string resource document"]
+
+strings_xml = %q{<foo>}
+validator = AndroidStringResourcesValidator.new(strings_xml)
+validator.valid? # => false
+validator.errors # => ["Not a valid XML document"]
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/magplus/android_string_resources_validator/fork )
+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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/android_string_resources_validator.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'android_string_resources_validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "android_string_resources_validator"
+  spec.version       = AndroidStringResourcesValidator::VERSION
+  spec.authors       = ["Karl Eklund", "Lennart Fridén"]
+  spec.email         = ["backend@magplus.com"]
+  spec.summary       = %q{Validates an Android strings.xml file.}
+  spec.description   = %q{Validates an Android string resource file against the specification at http://developer.android.com/guide/topics/resources/string-resource.html.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "nokogiri"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard-rspec"
+end

data/lib/android_string_resources_validator/version.rb

@@ -0,0 +1,3 @@
+class AndroidStringResourcesValidator
+  VERSION = "0.0.1"
+end

data/lib/android_string_resources_validator.rb

@@ -0,0 +1,75 @@
+require "android_string_resources_validator/version"
+require 'nokogiri'
+
+class AndroidStringResourcesValidator
+  def initialize(string)
+    @string = string
+  end
+
+  def valid?
+    errors.empty?
+  end
+
+  def errors
+    strings.map(&:error).compact
+  end
+
+  private
+
+  attr_reader :string
+
+  def strings
+    doc.xpath('//resources/string').map do |element|
+      ElementString.new(element.text)
+    end
+  end
+
+  def doc
+    Nokogiri::XML(@string)
+  end
+
+  class ElementString
+    def initialize(string)
+      @string = string
+    end
+
+    def error
+      return "Apostrophes must be escaped" if unsurrounded_contains_unescaped_single_quotes
+      return "Double quotes must be escaped" if unsurrounded_contains_unescaped_double_quotes
+      return "Double quotes must be escaped or surrounded by single quotes" if string_without_double_quotes_contains_unescaped_double_quotes
+      return "Single quotes must be escaped or surrounded by double quotes" if string_without_single_quotes_contains_unescaped_single_quotes
+    end
+
+    def unsurrounded_contains_unescaped_single_quotes
+      !surrounded_by_double_quotes && !surrounded_by_single_quotes && contains_unescaped_single_quotes
+    end
+
+    def unsurrounded_contains_unescaped_double_quotes
+      !surrounded_by_double_quotes && !surrounded_by_single_quotes && contains_unescaped_double_quotes
+    end
+
+    def surrounded_by_double_quotes
+      @string[/\A".*"\z/]
+    end
+
+    def contains_unescaped_single_quotes
+      @string[/[^\\]'/]
+    end
+
+    def surrounded_by_single_quotes
+      @string[/\A'.*'\z/]
+    end
+
+    def contains_unescaped_double_quotes
+      @string[/[^\\]"/]
+    end
+
+    def string_without_single_quotes_contains_unescaped_single_quotes
+      @string[/\A'.*[^\\]'.*'\z/]
+    end
+
+    def string_without_double_quotes_contains_unescaped_double_quotes
+      @string[/\A".*[^\\]".*"\z/]
+    end
+  end
+end

data/spec/lib/android_string_resources_validator_spec.rb

@@ -0,0 +1,57 @@
+require 'android_string_resources_validator'
+
+describe AndroidStringResourcesValidator do
+  specify %q{"This'll work"} do
+    assert_valid %q{"This'll work"}
+  end
+
+  specify %q{This\'ll also work} do
+    assert_valid %q{This\'ll also work}
+  end
+
+  specify %q{This doesn't work} do
+    assert_invalid %q{This doesn't work}, "Apostrophes must be escaped"
+  end
+
+  specify %q{'A lonely " seems weird, but is allowed'} do
+    assert_valid %q{'A lonely " seems weird, but is allowed'}
+  end
+
+  specify %q{A lonely \" seems weird, but is allowed} do
+    assert_valid %q{A lonely \" seems weird, but is allowed}
+  end
+
+  specify %q{A lonely " is not allowed} do
+    assert_invalid %q{A lonely " is not allowed}, "Double quotes must be escaped"
+  end
+
+  specify %q{"A lonely " is not allowed"} do
+    assert_invalid %q{"A lonely " is not allowed"}, "Double quotes must be escaped or surrounded by single quotes"
+  end
+
+  specify %q{'A lonely ' is not allowed'} do
+    assert_invalid %q{'A lonely ' is not allowed'}, "Single quotes must be escaped or surrounded by double quotes"
+  end
+
+  specify %q{Special identifiers such as %& and %d are allowed} do
+    assert_valid %q{Special identifiers such as %& and %d are allowed}
+  end
+
+  private
+
+  def strings_xml(string)
+    %Q{<resources><string name="hello">#{string}</string></resources>}
+  end
+
+  def assert_valid(string)
+    validator = AndroidStringResourcesValidator.new(strings_xml(string))
+    validator.errors.should == []
+    validator.should be_valid
+  end
+
+  def assert_invalid(string, error_message)
+    validator = AndroidStringResourcesValidator.new(strings_xml(string))
+    validator.should_not be_valid
+    validator.errors.should == Array(error_message)
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: android_string_resources_validator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Karl Eklund
+- Lennart Fridén
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: 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'
+- !ruby/object:Gem::Dependency
+  name: guard-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: Validates an Android string resource file against the specification at
+  http://developer.android.com/guide/topics/resources/string-resource.html.
+email:
+- backend@magplus.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- android_string_resources_validator.gemspec
+- lib/android_string_resources_validator.rb
+- lib/android_string_resources_validator/version.rb
+- spec/lib/android_string_resources_validator_spec.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: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Validates an Android strings.xml file.
+test_files:
+- spec/lib/android_string_resources_validator_spec.rb