freakin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 96be23895a633ea329593d762b32cfe80827578a
+  data.tar.gz: 33d513e75544b5bb035ece46f20f1c702c2fd94d
+SHA512:
+  metadata.gz: 27b83837d3dfdcac95c332af5f092da8ac973e2a10d84c19916c7e4005b6ea0a7f4510fe1c65af559f4b2fec0f9c6a1c82464b112dd1b0149378e58b5a7c8474
+  data.tar.gz: a71d74057947f2355b9931a505ca92b1274f9b659954f8da54a110619aa07fa34207b052c78be795ea9d3cbf6eaa4c8e7eede39582603ad04453665d909bba94

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/html/

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,21 @@
+AllCops:
+  Exclude:
+    # Bin contains standard files created when gem is initialised and therefore they should be left as is
+    - 'bin/**/*'
+    # Exe contains standard files created when gem is initialised and therefore they should be left as is
+    - 'exe/**/*'
+    # Rakefile is generated when gem is initialised and therefore should be left as is
+    - 'Rakefile'
+    # Gemfile is generated when gem is initialised and therefore should be left as is
+    - 'Gemfile'
+  # Cop names are not displayed in offense messages by default. We find it useful to include this information so we can
+  # use it to investigate what the fix may be.
+  DisplayCopNames: true
+  # Style guide URLs are not displayed in offense messages by default. Again we find it useful to go straight to the
+  # documentation for a rule when investigating what the fix may be.
+  DisplayStyleGuide: true
+
+# Disable this rubocop style because we want to make the arguments passed into quke available to anywhere when the code
+# is executed rubocop:disable Style/GlobalVars
+Style/GlobalVars:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,15 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5
+
+# Travis CI clones repositories to a depth of 50 commits, which is only really
+# useful if you are performing git operations.
+# https://docs.travis-ci.com/user/customizing-the-build/#Git-Clone-Depth
+git:
+  depth: 3
+
+# enable Bundler caching
+# https://docs.travis-ci.com/user/languages/ruby#Caching-Bundler
+cache: bundler

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alan Cruikshanks
+
+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,71 @@
+# Freakin
+
+[![Gem Version](https://badge.fury.io/rb/freakin.svg)](https://badge.fury.io/rb/freakin)
+
+This gem is ***freakin awesome*** in that it does nothing useful! It is purely an exercise in me getting to grips with creating an executable gem.
+
+> Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/freakin`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+### Actual installation
+
+As **Freakin** has not yet been released to Rubygems the out of the box installation notes below won't work, but are preserved for when this does get released.
+
+To install the gem having cloned the directory execute
+
+    $ bundle exec rake install
+
+### Standard installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'freakin'
+```
+
+And then execute
+
+    $ bundle
+
+Or install it yourself as
+
+    $ gem install freakin
+
+## Usage
+
+### Development
+
+Whilst just developing a gem like **Freakin** you can execute it with
+
+    $ ruby -Ilib ./exe/freakin
+
+and pass in arguments as well
+
+    $ ruby -Ilib ./exe/freakin 'spanish'
+
+### Actual
+
+Once installed you can just call
+
+    $ bundle exec freakin
+
+and
+
+    $ bundle exec freakin 'spanish'
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cruikshanks/freakin.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+> If you don't add a license it's neither free or open!

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rdoc/task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+RDoc::Task.new do |doc|
+  doc.main   = 'README.md'
+  doc.title  = 'Freakin'
+  doc.rdoc_files = FileList.new %w[README.md lib LICENSE.txt]
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "freakin"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/freakin

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "freakin"
+
+puts Freakin::Freakin.hi(ARGV[0])

data/freakin.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'freakin/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'freakin'
+  spec.version       = Freakin::VERSION
+  spec.authors       = ['Alan Cruikshanks']
+  spec.email         = ['alan.cruikshanks@gmail.com']
+
+  spec.summary       = 'A freakin awesome gem'
+  spec.description   = 'A freakin awesome gem that does nothing, awesomely!'
+  spec.homepage      = 'https://github.com/cruikshanks/freakin'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the
+  # 'allowed_push_host' to allow pushing to a single host or delete this section
+  # to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect /
+           against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rdoc', '~> 4.2'
+end

data/lib/freakin/translator.rb

@@ -0,0 +1,30 @@
+module Freakin #:nodoc:
+  # An instance of +Translator+ will determine what greeting to return based
+  # on the language selected when its instantiated
+  class Translator
+    # Instantiate a new instance of Translator for a chosen language
+    #
+    # ==== Examples
+    #
+    #   Freakin::Translator.new('spanish')
+    #
+    def initialize(language)
+      @language = language
+    end
+
+    # Call to return a greeting
+    # ==== Examples
+    #
+    #   foo = Freakin::Translator.new('spanish')
+    #   foo.hi # 'hola mundo'
+    #
+    def hi
+      case @language
+      when 'spanish'
+        'hola mundo'
+      else
+        'hello world'
+      end
+    end
+  end
+end

data/lib/freakin/version.rb

@@ -0,0 +1,3 @@
+module Freakin #:nodoc:
+  VERSION = '0.1.0'.freeze
+end

data/lib/freakin.rb

@@ -0,0 +1,25 @@
+require 'freakin/version'
+require 'freakin/translator'
+
+module Freakin #:nodoc:
+  # The main Freakin class. It is not intended to be instantiated and instead
+  # just need to call its hi method.
+  class Freakin
+    # When called returns a greeting matching the language defined. Currently
+    # supports English and Spanish.
+    #
+    # ==== Attributes
+    #
+    # * +language+ - Set to select a different language. Default is +english+.
+    #
+    # ==== Examples
+    #
+    #   Freakin::Freakin.hi
+    #   Freakin::Freakin.hi('spanish')
+    #
+    def self.hi(language = 'english')
+      trans = Translator.new(language)
+      trans.hi
+    end
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: freakin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alan Cruikshanks
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: A freakin awesome gem that does nothing, awesomely!
+email:
+- alan.cruikshanks@gmail.com
+executables:
+- freakin
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/freakin
+- freakin.gemspec
+- lib/freakin.rb
+- lib/freakin/translator.rb
+- lib/freakin/version.rb
+homepage: https://github.com/cruikshanks/freakin
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A freakin awesome gem
+test_files: []