fen 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8873bc81601ea709b1e59a2f9894ac69b15071ee52072aabd5e1c99db23da8ea
+  data.tar.gz: 20c82a80c665fd821895b7c38ceb5d711b9c456596baea247c875ede66cdb9de
+SHA512:
+  metadata.gz: d13f75fb533bec2391762af05fe7caf375ff72217f40b76e8e4091638af9f59c553035b9706863ed21e15ae8a056304f0515aeb9575f1d474012b0239ffa49b8
+  data.tar.gz: a1091892079135f5de6f07ee925d87bab3d939623c3e27729a7db88af68385b604ec4756119be316f142063d230431e279ad03742b624e257b67920a7c7cf346

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in fen.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    fen (0.1.0)
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aruba (1.0.0.pre.alpha.4)
+      childprocess (~> 1.0)
+      contracts (~> 0.13)
+      cucumber (>= 2.4, < 4.0)
+      ffi (~> 1.9)
+      rspec-expectations (~> 3.4)
+      thor (~> 0.19)
+    backports (3.15.0)
+    builder (3.2.3)
+    childprocess (1.0.1)
+      rake (< 13.0)
+    contracts (0.16.0)
+    cucumber (3.1.2)
+      builder (>= 2.1.2)
+      cucumber-core (~> 3.2.0)
+      cucumber-expressions (~> 6.0.1)
+      cucumber-wire (~> 0.0.1)
+      diff-lcs (~> 1.3)
+      gherkin (~> 5.1.0)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.2)
+    cucumber-core (3.2.1)
+      backports (>= 3.8.0)
+      cucumber-tag_expressions (~> 1.1.0)
+      gherkin (~> 5.0)
+    cucumber-expressions (6.0.1)
+    cucumber-tag_expressions (1.1.1)
+    cucumber-wire (0.0.1)
+    diff-lcs (1.3)
+    ffi (1.11.1)
+    gherkin (5.1.0)
+    multi_json (1.14.1)
+    multi_test (0.1.2)
+    rake (10.5.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    thor (0.20.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba (~> 1.0.0.pre.alpha.4)
+  bundler (~> 1.17)
+  fen!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Dominic Lupo
+
+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,62 @@
+# fen
+
+fen is a command line tool to work with chess fen or pgn.
+
+## Features
+
+Command line interface to convert fen into unicode chessboard with
+file and rank notation.
+
+## TODO
+
+pgn parser
+
+pgn to fen converter
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fen'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fen
+
+## Usage
+
+$ fen display r1bqk2r/pppp1ppp/2n2n2/2b1p3/2BPP3/2P2N2/PP3PPP/RNBQK2R b KQkq - 0 5
+```
+   a  b  c  d  e  f  g  h  
+  ┌──┬──┬──┬──┬──┬──┬──┬──┐
+8 │♜ │  │♝ │♛ │♚ │  │  │♜ │ 8
+  ├──┼──┼──┼──┼──┼──┼──┼──┤
+7 │♟ │♟ │♟ │♟ │  │♟ │♟ │♟ │ 7
+  ├──┼──┼──┼──┼──┼──┼──┼──┤
+6 │  │  │♞ │  │  │♞ │  │  │ 6
+  ├──┼──┼──┼──┼──┼──┼──┼──┤
+5 │  │  │♝ │  │♟ │  │  │  │ 5
+  ├──┼──┼──┼──┼──┼──┼──┼──┤
+4 │  │  │♗ │♙ │♙ │  │  │  │ 4
+  ├──┼──┼──┼──┼──┼──┼──┼──┤
+3 │  │  │♙ │  │  │♘ │  │  │ 3
+  ├──┼──┼──┼──┼──┼──┼──┼──┤
+2 │♙ │♙ │  │  │  │♙ │♙ │♙ │ 2
+  ├──┼──┼──┼──┼──┼──┼──┼──┤
+1 │♖ │♘ │♗ │♕ │♔ │  │  │♖ │ 1
+  └──┴──┴──┴──┴──┴──┴──┴──┘
+   a  b  c  d  e  f  g  h  
+```
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/DomPSU/fen.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+desc 'Run unit tests'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/fen_test.rb'
+  t.verbose = true
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fen"
+
+# 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__)

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/fen

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'fen/cli'
+Fen::CLI.start

data/fen.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "fen/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fen"
+  spec.version       = Fen::VERSION
+  spec.authors       = ["Dominic Lupo"]
+  spec.email         = ["DominicLupo5318@gmail.com"]
+
+  spec.summary       = "fen is a command line tool to work with chess fen or pgn."
+  spec.description   = "Currently fen supports a command line tool to convert"\
+                       "fen to a unicode chess board with rank and file notation"\
+                       "Future versions will include a pgn parser and a pgn to fen"\
+                       "converter."
+                       
+  spec.homepage      = "https://github.com/DomPSU/fen"
+  spec.license       = "MIT"
+
+  # 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_dependency "thor"
+end

data/lib/fen.rb

@@ -0,0 +1,7 @@
+require "fen/version"
+require "fen/display"
+require "fen/chess_constants"
+
+module Fen
+  class Error < StandardError; end
+end

data/lib/fen/chess_constants.rb

@@ -0,0 +1,7 @@
+module ChessConstants
+  NUMBER_OF_ROWS = 8
+  NUMBER_OF_COLUMNS = 8
+  
+  FILE_ARRAY = ["a", "b", "c", "d", "e", "f", "g", "h"]
+  RANK_ARRAY = ["1", "2", "3", "4", "5", "6", "7", "8"]
+end

data/lib/fen/cli.rb

@@ -0,0 +1,12 @@
+require 'thor'
+require 'fen'
+
+module Fen
+  class CLI < Thor
+    desc "display FEN", "Displays fen."
+    def display(*fen)
+      fen = Display.new(fen.join(" "))
+      print(fen.board)
+    end
+  end
+end

data/lib/fen/display.rb

@@ -0,0 +1,162 @@
+require_relative 'chess_constants'
+
+class Display
+  attr_accessor :fen
+  attr_reader :piece_array
+
+  def initialize(fen)
+    @fen = fen
+    @piece_array = convert_fen_to_piece_array
+  end
+
+  def convert_fen_to_piece_array
+    fen_array = @fen.split("/")
+
+    first_rank_and_details = fen_array.last.split(" ")
+    first_rank = first_rank_and_details[0]
+
+    piece_array = fen_array
+    piece_array[-1] = first_rank
+    
+    @piece_array = piece_array
+  end
+
+  def board
+    board = file_notation_row
+    board += top_row
+
+    ChessConstants::RANK_ARRAY.reverse.each do |rank|
+      board += piece_row(rank.to_i)
+      board += line_row unless rank.to_i == 1
+    end
+
+    board += bottom_row
+    board += file_notation_row
+  end
+
+  def file_notation_row
+    file_notation_row = "   "
+    ChessConstants::FILE_ARRAY.each { |value| file_notation_row += "#{value}  "}
+    file_notation_row += "\n"
+  end
+
+  def top_row
+    counter = 0
+    top_row = "  "
+    top_row += unicode_board(:top_left_corner)
+    top_row += unicode_board(:horizontal)
+    top_row += unicode_board(:horizontal)
+
+    loop do
+      top_row += unicode_board(:top_mid)
+      top_row += unicode_board(:horizontal)
+      top_row += unicode_board(:horizontal)
+      counter += 1
+      break if counter == ChessConstants::NUMBER_OF_COLUMNS - 1
+    end
+    top_row += unicode_board(:top_right_corner)
+    top_row += "\n"
+  end
+
+  def piece_row(rank_notation) 
+    piece_row = rank_notation.to_s
+    piece_row += " "
+
+    @piece_array.reverse[rank_notation - 1].each_char do |board_square|
+      piece_row += unicode_board(:vertical)
+
+      if board_square.to_i > 1 
+        (board_square.to_i - 1).times do
+          piece_row += "  "
+          piece_row += unicode_board(:vertical)
+        end
+
+        piece_row += " "
+      elsif board_square.to_i == 1
+        piece_row += " "
+      else
+        piece_row += unicode_piece(board_square.to_sym)
+      end
+      piece_row += " "
+    end
+
+    piece_row += unicode_board(:vertical)
+
+    piece_row += " "
+    piece_row += rank_notation.to_s
+    piece_row += "\n"
+  end
+
+  def line_row
+    counter = 0
+
+    line_row =  "  "
+    line_row += unicode_board(:left_mid)
+    line_row += unicode_board(:horizontal)
+    line_row += unicode_board(:horizontal)
+
+    loop do
+      line_row += unicode_board(:cross)
+      line_row += unicode_board(:horizontal)
+      line_row += unicode_board(:horizontal)
+      counter += 1
+      break if counter == ChessConstants::NUMBER_OF_COLUMNS - 1
+    end
+    line_row += unicode_board(:right_mid)
+    line_row += "\n"    
+  end
+
+  def bottom_row 
+
+    counter = 0
+
+    bottom_row = "  "
+    bottom_row += unicode_board(:bottom_left_corner)
+    bottom_row += unicode_board(:horizontal)
+    bottom_row += unicode_board(:horizontal)
+
+    loop do
+      bottom_row += unicode_board(:bottom_mid)
+      bottom_row += unicode_board(:horizontal)
+      bottom_row += unicode_board(:horizontal)
+      counter += 1
+      break if counter == ChessConstants::NUMBER_OF_COLUMNS - 1
+    end
+    bottom_row += unicode_board(:bottom_right_corner)  
+    bottom_row += "\n"
+  end
+
+  def unicode_board(key)
+    hash = {horizontal: "\u2500",
+            vertical: "\u2502",
+            top_left_corner: "\u250C",
+            top_right_corner: "\u2510",
+            bottom_left_corner: "\u2514",
+            bottom_right_corner: "\u2518",
+            top_mid: "\u252c",
+            left_mid: "\u251c",
+            right_mid: "\u2524",
+            bottom_mid: "\u2534",
+            cross: "\u253c"}
+
+    return hash.fetch(key).encode('utf-8')   
+  end
+
+  def unicode_piece(piece)
+
+    hash = {K: "\u2654",
+            Q: "\u2655",
+            R: "\u2656",
+            B: "\u2657",
+            N: "\u2658",
+            P: "\u2659",
+            k: "\u265A",
+            q: "\u265B",
+            r: "\u265C",
+            b: "\u265D",
+            n: "\u265E",
+            p: "\u265F"}
+
+    return hash.fetch(piece).encode('utf-8')
+  end
+end

data/lib/fen/version.rb

@@ -0,0 +1,3 @@
+module Fen
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: fen
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dominic Lupo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: thor
+  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'
+description: Currently fen supports a command line tool to convertfen to a unicode
+  chess board with rank and file notationFuture versions will include a pgn parser
+  and a pgn to fenconverter.
+email:
+- DominicLupo5318@gmail.com
+executables:
+- fen
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/fen
+- fen.gemspec
+- lib/fen.rb
+- lib/fen/chess_constants.rb
+- lib/fen/cli.rb
+- lib/fen/display.rb
+- lib/fen/version.rb
+homepage: https://github.com/DomPSU/fen
+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: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: fen is a command line tool to work with chess fen or pgn.
+test_files: []