cargem 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d52b3f420b75858d98ddeaf771f032854b13852
-  data.tar.gz: a2f65448e5e6224a51ef6707d4f31c96268ed409
+  metadata.gz: 0a824c5fbcf5d296983c8cc5e660001d09157f5c
+  data.tar.gz: 6e3f2419927ff4e04a44a48029851062c86305c4
 SHA512:
-  metadata.gz: 7ae5a9c83d52c4854ae27eb2e252d5635e468769dd50d08be369c7992b96bc484262d83544849a187980d14ed752be8be476d53af9281bfc95dcbdfde655413f
-  data.tar.gz: 2dbb8080ba11a63833b9e8357b242ffbd61fe2355aef8f9547aa144954fe90ca45e7028295abf44ef1bd14f6219f9743adc5709503282447f39816cd270530cc
+  metadata.gz: 7272c578ebc454ad63a78bc53efc7e895fd68301aac811dc51e99e192668b276b1b148194278614cd88d3492904dc9a41f7bf14e0006dff9eb2e406ef6930adc
+  data.tar.gz: f476ce7f5d08bb4f13533cd3f2de6bbe145569e801a3f27bf3ae77b3f2582fc1d7d5b534167ff39a48babd1969642ec41cfd4442e9b9b9333fa1b41f48558143

data/.gitlab-ci.yml

@@ -1,9 +1,9 @@
-image: ruby:2.3.1
+image: ruby:2.4.4
 
-before_script: 
+before_script:
   - gem install bundler
   - bundle install
 
 test:
   script:
-    - bundle exec rspec
+    - bundle exec rake spec

data/README.md

@@ -1,12 +1,59 @@
-## What does CarGem do?
+# Cargem
 
-CarGem allows the author of a ruby script to instantiate convieniently configured Car objects in various versions.
+Cargem allows the user instantiate convieniently configured Car objects in various versions.
 
-Here's an example use, where we generate a Camaro and tell it to drive.
+Completed as a technical exercise during interview process for Best Buy.
 
-`irb>  require 'cargem' && Camaro.new.drive `
+## Installation
+
+Install this gem directly with:
+
+`$ gem install compensate`
+
+## Usage
+
+### Command-line
+
+This gem includes a packaged bin/ executable that demonstrates behavior, for convenience. 
+
+After installation, call `cargem-drive-camaro` at the command line to see a Camaro in action!
+
+### Ruby script
+
+Here's an example use, where we generate a Camaro-type Car object and tell it to drive.
+
+After the gem is installed, initialize a script for our code to live in:
+
+`$ touch main.rb`
+
+Edit this script to include the following code snippet:
+
+```ruby
+#!/usr/bin/env ruby
+
+require 'cargem'
+
+car = Cargem::Camaro.new
+car.drive
+```
+
+Save the file, and change the permissions to make it executable:
+
+`$ chmod +x main.rb`
+
+Then run the script:
+
+`$ ./main.rb`
+
+You should see output of the car accelerating up to its maximum speed.
 
 ### Class methods
 
-* `Camaro#accelerate  # Increments current_speed by 1`
-* `Camaro#drive # Drive calls accelerate until it hits max speed`
+* `Car#accelerate  # Increments current_speed by 1`
+* `Car#drive # Drive calls accelerate until it hits max speed`
+
+## 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).

data/Rakefile

@@ -1,8 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec) do |task|
-  task.rspec_opts = ['--color', '--format', 'nested']
-end
+RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/cargem-drive-camaro

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'cargem'
+
+car = Cargem::Camaro.new
+car.drive

data/cargem.gemspec

@@ -1,41 +1,26 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'cargem/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "cargem"
+  spec.name          = 'cargem'
   spec.version       = Cargem::VERSION
-  spec.authors       = ["Keifer Furzland"]
-  spec.email         = ["kfrz.code@gmail.com"]
+  spec.authors       = ['Keifer Furzland']
+  spec.email         = ['kfrz.code@gmail.com']
 
-  spec.summary       = %q{"This is a simple car-generation gem"}
-  spec.description   = %q{"This is meant to be an example of how to build a simple Ruby gem."}
-  spec.homepage      = "https://github.com/kfrz/cargem"
+  spec.summary       = %q('This is a simple car-generation gem')
+  spec.description   = %q('This is meant to be an example of how to build a simple Ruby gem.')
+  spec.homepage      = 'https://gitlab.com/kfrz/cargem'
 
-  # 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'] = "TODO: Set to 'http://mygemserver.com'"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.executables << 'cargem-drive-camaro'
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rspec-nc"
-  spec.add_development_dependency "guard"
-  spec.add_development_dependency "guard-rspec"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "pry-remote"
-  spec.add_development_dependency "pry-nav"
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
 end

data/lib/cargem.rb

@@ -1,6 +1,4 @@
-require "cargem/version"
-require "cargem/car"
-require "cargem/camaro"
+require 'cargem/version'
 
-module Cargem
-end
+require 'cargem/car'
+require 'cargem/camaro'

data/lib/cargem/camaro.rb

@@ -2,8 +2,7 @@ module Cargem
   class Camaro < Car
     def initialize
       super
-      @make = "Chevy"
-      @model = "Camaro"
+      @brand = "Chevy"
       @max_speed = 200
     end
   end

data/lib/cargem/car.rb

@@ -1,42 +1,29 @@
 module Cargem
   class Car
+    attr_accessor :brand, :current_speed, :max_speed
+
     def initialize
-      @make = "unknown"
-      @model = "unknown"
-      @max_speed = 0
-      @current_speed = 0
-    end
-   
-    def accelerate
-      @current_speed += 1
+      @brand = brand ||'unknown'
+      @current_speed = current_speed || 0
+      @max_speed = max_speed || 0
     end
-    
-    def brand
-      @make + @model
-    end
- 
-    def current_speed
-      @current_speed
-    end 
 
     def drive
       while @current_speed <= @max_speed
         puts "#{@current_speed}"
         accelerate
       end
-      print "The #{@make} #{@model} has hit its max speed of #{@max_speed} and will now stop accelerating."
+      print stopped_acceleration_message
     end
 
-    def make
-      @make
+    def accelerate
+      @current_speed += 1
     end
 
-    def model
-      @model
-    end
+    private
 
-    def max_speed
-      @max_speed 
+    def stopped_acceleration_message
+      "The #{brand} has hit its max speed of #{@max_speed} and will now stop accelerating."
     end
   end
 end

data/lib/cargem/version.rb

@@ -1,3 +1,3 @@
 module Cargem
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cargem
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Keifer Furzland
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2016-11-08 00:00:00.000000000 Z
+date: 2018-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,94 +52,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rspec-nc
-  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: '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'
-- !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-remote
-  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'
-description: '"This is meant to be an example of how to build a simple Ruby gem."'
+description: "'This is meant to be an example of how to build a simple Ruby gem.'"
 email:
 - kfrz.code@gmail.com
-executables: []
+executables:
+- cargem-drive-camaro
 extensions: []
 extra_rdoc_files: []
 files:
@@ -150,18 +67,17 @@ files:
 - Guardfile
 - README.md
 - Rakefile
+- bin/cargem-drive-camaro
 - bin/console
 - bin/setup
 - cargem.gemspec
 - lib/cargem.rb
 - lib/cargem/camaro.rb
 - lib/cargem/car.rb
-- lib/cargem/cargem.rb
 - lib/cargem/version.rb
-homepage: https://github.com/kfrz/cargem
+homepage: https://gitlab.com/kfrz/cargem
 licenses: []
-metadata:
-  allowed_push_host: https://rubygems.org
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -178,8 +94,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
-summary: '"This is a simple car-generation gem"'
+summary: "'This is a simple car-generation gem'"
 test_files: []

data/lib/cargem/cargem.rb

@@ -1,7 +0,0 @@
-class Camaro < Car
-  def initialize
-    super
-    @brand = "Chevy"
-    @max_speed = 200
-  end
-end