groovy_oneliner 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b8dc13200f769f7b66bd2b61badef306f15d2a16
+  data.tar.gz: 5a80d432721ab5a87f406da1312c42c1765c7c4e
+SHA512:
+  metadata.gz: b5317e989aa0498890c3d93d59b8e11503874c5d48a0594ff348d49be60802153e47bf93685306ca2527159ac01260a534e25ca50c6d73a105af91f94dccdf62
+  data.tar.gz: 2ba1bb414ae2d252e65c167286b918b8932203f0d687484e0b6cd973a3fd12d3c8ef58dbd14f4728965218928731c96deeabf9076cc7e4d95bd92a73c537ed6e

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,7 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Pedro Cunha
+
+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,75 @@
+# GroovyOneliner
+
+Convert any groovy script file to a single line script. It is recommended (and also in order for this gem to work) that all lines must be terminated with `;`.
+
+### What would this help with ?
+In order to do scripting in [ElasticSearch](https://github.com/elasticsearch/elasticsearch) you can pick an handful of languages to inject code in your queries however ElasticSearch requires you that any script is written as a single line of code (not to mention the obvious properly formatted with `;`) at query time. 
+
+One of the languages supported is Groovy. Groovy is very similar to Java. 
+
+`GroovyOneliner` was extracted from one of the production apps at [HouseTrip](http://housetrip.com), since it allows to have a separate file for the Groovy script, which benefits: syntax highlighting, multilines, comments etc... and convert that script into one liner that you can use for queries. Nevertheless is important to say this is being used in production.
+
+It is simple as it is, i.e, there are no external dependencies and while it's a very small task, it should allow to avoid repeating the same parsing code over and over.
+
+This gem won't do for you:
+- Check if there is any syntax errors
+- Check if you hate semi-colons
+
+What does it actually do:
+- Removes all `//` & `\* ... */` comments
+- Attempts to remove as much white space as possible such as empty lines, between `;`, etc..
+
+Some file examples and the corresponding output when using this gem:
+
+### Example
+
+```groovy
+// This line is amazing
+a = 1;
+
+/*
+ * Foo
+ */
+b = 2;
+```
+
+Converts to
+```groovy
+a = 1; b = 2;
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'groovy_oneliner'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install groovy_oneliner
+
+## Usage
+
+```
+GroovyOneliner.compute(file: 'path/to/file')
+```
+
+If you want to cache reading the file (recommended for production & staging environments)
+
+```
+GroovyOneliner.compute(file: 'path/to/file', cache: true)
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/pedrocunha/groovy_oneliner/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 a new Pull Request

data/Rakefile

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

data/groovy_oneliner.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'groovy_oneliner/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "groovy_oneliner"
+  spec.version       = GroovyOneliner::VERSION
+  spec.authors       = ["Pedro Cunha"]
+  spec.email         = ["pkunha@gmail.com"]
+  spec.summary       = %q{Convert groovy scripts into one line script}
+  spec.homepage       = 'http://github.com/pedrocunha/groovy_oneliner'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3'
+  spec.add_development_dependency 'pry', '~> 0'
+  spec.add_development_dependency 'pry-nav', '~> 0'
+  spec.add_development_dependency 'guard', '~> 2.9'
+  spec.add_development_dependency 'guard-rspec', '~> 4'
+end

data/lib/groovy_oneliner/cache.rb

@@ -0,0 +1,23 @@
+require 'groovy_oneliner'
+
+class GroovyOneliner
+  class Cache
+
+    def initialize
+      @cache = {}
+    end
+
+    def [](key)
+      @cache[key]
+    end
+
+    def []=(key, value)
+      @cache[key] = value
+    end
+
+    def reset!
+      @cache = {}
+    end
+
+  end
+end

data/lib/groovy_oneliner/converter.rb

@@ -0,0 +1,20 @@
+require 'groovy_oneliner'
+
+class GroovyOneliner
+  class Converter
+
+    def initialize(content)
+      @content = content
+    end
+
+    def compute
+      @content
+           .gsub(/\/\/.*$/, '')      # remove all comments //
+           .gsub("\n", '')           # remove all line-breaks
+           .gsub("\"", "'")          # substitute all double-quote to single-quote
+           .gsub(/^$/, '')           # remove all empty lines
+           .gsub(/;\s*/, ';')        # remove all whitespace after ;
+           .gsub(%r{/\*.*\*\/}, '')  # remove all comments /* ... */
+    end
+  end
+end

data/lib/groovy_oneliner/version.rb

@@ -0,0 +1,3 @@
+class GroovyOneliner
+  VERSION = "1.0.0"
+end

data/lib/groovy_oneliner.rb

@@ -0,0 +1,33 @@
+require 'groovy_oneliner/version'
+require 'groovy_oneliner/cache'
+require 'groovy_oneliner/converter'
+require 'singleton'
+
+class GroovyOneliner
+  include Singleton
+
+  def initialize
+    @cache = GroovyOneliner::Cache.new
+  end
+
+  def compute(options = {})
+    path         = options.fetch(:path)
+    should_cache = options.fetch(:cache, false)
+
+    if should_cache
+      cached_content = @cache[path]
+      return cached_content if cached_content
+    end
+
+    content = File.read(path)
+    output  = GroovyOneliner::Converter.new(content).compute
+
+    should_cache ? @cache[path] = output : output
+  end
+
+  def self.compute(options = {})
+    self.instance.compute(options)
+  end
+
+end
+

data/spec/groovy_oneliner/cache_spec.rb

@@ -0,0 +1,26 @@
+require 'groovy_oneliner/cache'
+
+RSpec.describe GroovyOneliner::Cache do
+  subject { described_class.new }
+
+  describe '#[]' do
+    it 'returns empty if nothing on cache' do
+      expect(subject['foo']).to be_nil
+    end
+  end
+
+  describe '#[]=' do
+    it 'stores the value in the key' do
+      expect(subject['foo'] = 'yadada').to eql('yadada')
+    end
+  end
+
+  describe '#reset' do
+    it 'resets the cache' do
+      subject['foo'] = 'bar'
+      subject.reset!
+
+      expect(subject['foo']).to be_nil
+    end
+  end
+end

data/spec/groovy_oneliner/converter_spec.rb

@@ -0,0 +1,65 @@
+require 'groovy_oneliner/converter'
+
+RSpec.describe GroovyOneliner::Converter do
+
+  describe '#initialization' do
+    it 'raises an error on missing argument' do
+      expect { described_class.new }.to raise_error
+    end
+
+    it 'returns an instance when good argument' do
+      expect { described_class.new("foo") }.to_not raise_error
+    end
+  end
+
+  describe '#compute' do
+
+    it 'removes all // comments' do
+      subject = described_class.new <<-TEXT
+// This is a comment and will be ignored
+return 1;
+      TEXT
+
+      expect(subject.compute).to eql("return 1;")
+    end
+
+    it 'removes all line breaks' do
+      subject = described_class.new <<-TEXT
+a = 3;
+return 1;
+      TEXT
+
+      expect(subject.compute).to eql("a = 3;return 1;")
+    end
+
+    it 'removes all empty lines' do
+      subject = described_class.new <<-TEXT
+a = 4;
+
+b = 5;
+      TEXT
+
+      expect(subject.compute).to eql("a = 4;b = 5;")
+    end
+
+    it 'removes all whitespace after ;' do
+      subject = described_class.new <<-TEXT
+a = 4; b = 5;
+      TEXT
+
+      expect(subject.compute).to eql("a = 4;b = 5;")
+    end
+
+    it 'removes all /* comment */ blocks' do
+      subject = described_class.new <<-TEXT
+/*
+ * This is a comment and will be ignored
+ */
+return 1;
+      TEXT
+
+      expect(subject.compute).to eql("return 1;")
+    end
+
+  end
+end

data/spec/groovy_oneliner_spec.rb

@@ -0,0 +1,42 @@
+require 'groovy_oneliner'
+
+RSpec.describe GroovyOneliner do
+
+  it 'does not allow to initialize an instance of this class' do
+    expect { described_class.new }.to raise_error
+  end
+
+  describe '.compute' do
+
+    let(:path)    { 'path/to/file' }
+    let(:options) { { path: path } }
+
+    subject { described_class }
+
+    it 'allows to compute a file' do
+      expect(File).to receive(:read).once.with(path).and_return("foo = 1;")
+      subject.compute(options)
+    end
+
+    context 'when caching is off' do
+      it 'reads the file as many times as calls to compute' do
+        expect(File).to receive(:read).twice.with(path).and_return("foo = 1;")
+        subject.compute(options)
+        subject.compute(options)
+      end
+    end
+
+    context 'when caching is on' do
+      let(:options) { { path: path, cache: true } }
+
+      it 'reads the file only once' do
+        expect(File).to receive(:read).once.with(path).and_return("foo = 1;")
+        subject.compute(options)
+        subject.compute(options)
+      end
+    end
+
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,65 @@
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: groovy_oneliner
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Pedro Cunha
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: pry-nav
+  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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: 
+email:
+- pkunha@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- groovy_oneliner.gemspec
+- lib/groovy_oneliner.rb
+- lib/groovy_oneliner/cache.rb
+- lib/groovy_oneliner/converter.rb
+- lib/groovy_oneliner/version.rb
+- spec/groovy_oneliner/cache_spec.rb
+- spec/groovy_oneliner/converter_spec.rb
+- spec/groovy_oneliner_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/pedrocunha/groovy_oneliner
+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.4.2
+signing_key: 
+specification_version: 4
+summary: Convert groovy scripts into one line script
+test_files: []