Skip to content

Commit

Permalink
initialize project and create tests
Browse files Browse the repository at this point in the history
  • Loading branch information
jdrobertso committed Apr 27, 2019
0 parents commit af83b29
Show file tree
Hide file tree
Showing 17 changed files with 256 additions and 0 deletions.
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
/.bundle/
/.yardoc
/_yardoc/
/coverage/
/doc/
/pkg/
/spec/reports/
/tmp/
6 changes: 6 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
source "https://rubygems.org"

git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }

# Specify your gem's dependencies in tic_tac_toe.gemspec
gemspec
21 changes: 21 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2019 Jeremy Robertson

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.
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# TicTacToe

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/tic_tac_toe`. To experiment with that code, run `bin/console` for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'tic_tac_toe'
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install tic_tac_toe

## Usage

TODO: Write usage instructions here

## Development

After checking out the repo, run `bin/setup` to install dependencies. 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/[USERNAME]/tic_tac_toe.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
2 changes: 2 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
require "bundler/gem_tasks"
task :default => :spec
14 changes: 14 additions & 0 deletions bin/console
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
#!/usr/bin/env ruby

require "bundler/setup"
require "tic_tac_toe"

# 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(__FILE__)
8 changes: 8 additions & 0 deletions bin/setup
Original file line number Diff line number Diff line change
@@ -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
9 changes: 9 additions & 0 deletions lib/tic_tac_toe.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
require "tic_tac_toe/version"
require_relative "tic_tac_toe/version"

module TicTacToe
class Error < StandardError; end
end

require_relative './tic_tac_toe/cell.rb'
require_relative './tic_tac_toe/player.rb'
13 changes: 13 additions & 0 deletions lib/tic_tac_toe/board.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
module TicTacToe
class Board
def initialize(input)
@grid = input.fetch(:grid, default_grid)
end

private

def default_grid
Array.new(3) {Array.new(3) {Cell.new}}
end
end
end
8 changes: 8 additions & 0 deletions lib/tic_tac_toe/cell.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
module TicTacToe
class Cell
attr_accessor :value
def initialize(value = "")
@value = value
end
end
end
9 changes: 9 additions & 0 deletions lib/tic_tac_toe/player.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
module TicTacToe
class Player
attr_reader :color, :name
def initialize(input)
@color = input.fetch(:color)
@name = input.fetch(:name)
end
end
end
3 changes: 3 additions & 0 deletions lib/tic_tac_toe/version.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module TicTacToe
VERSION = "0.1.0"
end
29 changes: 29 additions & 0 deletions spec/board_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
require "spec_helper"

module TicTacToe
describe Board do
context "#initialize" do
it "initializes the board with a grid" do
expect { Board.new(grid: "grid") }.to_not raise_error
end
it "sets the grid with three rows by default" do
board = Board.new
expect(board.grid).to have(3).things
end
it "creates three things in each row by default" do
board = Board.new
board.grid.each do |row|
expect(row).to have(3).things
end
end
end

context "#grid" do
it "returns the grid" do
board = Board.new(grid: "blah")
expect(board.grid).to eq "blah"
end
end

end
end
16 changes: 16 additions & 0 deletions spec/cell_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
require "spec_helper"

module TicTacToe
describe Cell do
context "#initialize" do
it "is initialized with a value of '' by default" do
cell = Cell.new
expect(cell.value).to eq ''
end
it "can be initialized with a value of 'X'" do
cell = Cell.new("X")
expect(cell.value).to eq "X"
end
end
end
end
28 changes: 28 additions & 0 deletions spec/player_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
require "spec_helper"

module TicTacToe
describe Player do
context "#initialize" do

it "raises an exception when initialized with {}" do
expect { Player.new({}) }.to raise_error
end
end

context "#color" do
it "returns the color" do
input = {color: "X", name: "Someone"}
player = Player.new(input)
expect(player.color).to eq "X"
end
end

context "#name" do
it "returns the player's name" do
input = {color: "X", name:"Someone"}
player = Player.new(input)
expect(player.name).to eq "Someone"
end
end
end
end
1 change: 1 addition & 0 deletions spec/spec_helper.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
require_relative "../lib/tic_tac_toe.rb"
42 changes: 42 additions & 0 deletions tic_tac_toe.gemspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@

lib = File.expand_path("../lib", __FILE__)
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
require "tic_tac_toe/version"

Gem::Specification.new do |spec|
spec.name = "tic_tac_toe"
spec.version = TicTacToe::VERSION
spec.authors = ["Jeremy Robertson"]
spec.email = ["[email protected]"]

spec.summary = %q{TODO: Write a short summary, because RubyGems requires one.}
spec.description = %q{TODO: Write a longer description or delete this line.}
spec.homepage = "TODO: Put your gem's website or public repo URL here."
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"] = "TODO: Set to 'https://mygemserver.com'"

spec.metadata["homepage_uri"] = spec.homepage
spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
else
raise "RubyGems 2.0 or newer is required to protect against " \
"public gem pushes."
end

# Specify which files should be added to the gem when it is released.
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
`git ls-files -z`.split("\x0").reject { |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.add_development_dependency "bundler", "~> 1.17"
spec.add_development_dependency "rake", "~> 10.0"
spec.add_development_dependency "rspec"
end

0 comments on commit af83b29

Please sign in to comment.