boxybox 0.1.2

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rake/extensiontask'
+
+task build: :compile
+
+Rake::ExtensionTask.new('boxybox') do |ext|
+  ext.lib_dir = 'lib/boxybox'
+end
+
+task default: %i[clobber compile spec]

data/bin/console

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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'boxybox/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'boxybox'
+  spec.license       = 'MIT'
+  spec.version       = Boxybox::VERSION
+  spec.authors       = ['Travis Carter']
+  spec.email         = ['travis.carter79@outlook.com']
+
+  spec.summary       = 'Box generator for an at home code challenge'
+  spec.description   = 'Draws terminal ascii boxes, and boxes within boxes'
+  spec.homepage      = 'https://github.com/phatjam98/boxybox'
+
+  # 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'
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = spec.homepage
+    spec.metadata['changelog_uri'] = spec.homepage
+  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(__dir__)) 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.extensions    = ['ext/boxybox/extconf.rb']
+  spec.required_ruby_version = '>2.6'
+
+  spec.add_dependency 'pastel', '~> 0.7.2'
+  spec.add_dependency 'thor', '~> 0.20.0'
+  spec.add_dependency 'tty-box', '~> 0.5.0'
+  spec.add_dependency 'tty-color', '~> 0.5'
+  spec.add_dependency 'tty-command', '~> 0.9.0'
+  spec.add_dependency 'tty-config', '~> 0.3.2'
+  spec.add_dependency 'tty-cursor', '~> 0.7'
+  spec.add_dependency 'tty-editor', '~> 0.5'
+  spec.add_dependency 'tty-file', '~> 0.8.0'
+  spec.add_dependency 'tty-font', '~> 0.4.0'
+  spec.add_dependency 'tty-logger', '~> 0.2.0'
+  spec.add_dependency 'tty-markdown', '~> 0.6.0'
+  spec.add_dependency 'tty-pager', '~> 0.12'
+  spec.add_dependency 'tty-pie', '~> 0.3.0'
+  spec.add_dependency 'tty-platform', '~> 0.2'
+  spec.add_dependency 'tty-progressbar', '~> 0.17'
+  spec.add_dependency 'tty-prompt', '~> 0.19'
+  spec.add_dependency 'tty-screen', '~> 0.7'
+  spec.add_dependency 'tty-spinner', '~> 0.9'
+  spec.add_dependency 'tty-table', '~> 0.11.0'
+  spec.add_dependency 'tty-tree', '~> 0.3'
+  spec.add_dependency 'tty-which', '~> 0.4'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake-compiler'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.89.0'
+end

data/exe/boxybox

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+lib_path = File.expand_path('../lib', __dir__)
+$:.unshift(lib_path) if !$:.include?(lib_path)
+require 'boxybox/cli'
+
+Signal.trap('INT') do
+  warn("\n#{caller.join("\n")}: interrupted")
+  exit(1)
+end
+
+begin
+  Boxybox::CLI.start
+rescue Boxybox::CLI::Error => err
+  puts "ERROR: #{err.message}"
+  exit 1
+end

data/ext/boxybox/boxybox.c

@@ -0,0 +1,9 @@
+#include "boxybox.h"
+
+VALUE rb_mBoxybox;
+
+void
+Init_boxybox(void)
+{
+  rb_mBoxybox = rb_define_module("Boxybox");
+}

data/ext/boxybox/boxybox.h

@@ -0,0 +1,6 @@
+#ifndef BOXYBOX_H
+#define BOXYBOX_H 1
+
+#include "ruby.h"
+
+#endif /* BOXYBOX_H */

data/ext/boxybox/extconf.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'mkmf'
+
+create_makefile('boxybox/boxybox')

data/lib/boxybox.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'boxybox/version'
+
+module Boxybox
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/boxybox/cli.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module Boxybox
+  # Handle the application command line parsing
+  # and the dispatch to various command objects
+  #
+  # @api public
+  class CLI < Thor
+    # Error raised by this runner
+    Error = Class.new(StandardError)
+
+    desc 'version', 'boxybox version'
+    def version
+      require_relative 'version'
+      puts "v#{Boxybox::VERSION}"
+    end
+    map %w(--version -v) => :version
+
+    desc 'boxes [INPUT]', 'Accepts a config as defined in the README and prints ASCII boxes in the terminal'
+    method_option :help, aliases: '-h', type: :boolean,
+                         desc: 'Display usage information'
+    method_option :file, aliases: '-f', type: :string,
+                         desc: 'Specify a file path to use as the input'
+    method_option :example, aliases: '-e', type: :string,
+                            desc: 'Select example 1 to 4',
+                            banner: 'example1', enum: %w(example1 example2 example3 example4)
+    method_option :print_example, aliases: '-p', type: :boolean,
+                                  desc: 'Select the example json to output to terminal.'
+
+    def boxes(input = nil)
+      if options[:help]
+        invoke :help, ['boxes']
+      else
+        require_relative 'commands/boxes'
+        Boxybox::Commands::Boxes.new(input, options).execute
+      end
+    end
+  end
+end

data/lib/boxybox/command.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Boxybox
+  # This is generated from the TTY application bootstrap and is used to access the commands available to this app
+  class Command
+    extend Forwardable
+
+    def_delegators :command, :run
+
+    # Execute this command
+    #
+    # @api public
+    def execute(*)
+      raise(
+        NotImplementedError,
+        "#{self.class}##{__method__} must be implemented"
+      )
+    end
+
+    # The external commands runner
+    #
+    # @see http://www.rubydoc.info/gems/tty-command
+    #
+    # @api public
+    def command(**options)
+      require 'tty-command'
+      TTY::Command.new(options)
+    end
+
+    # The cursor movement
+    #
+    # @see http://www.rubydoc.info/gems/tty-cursor
+    #
+    # @api public
+    def cursor
+      require 'tty-cursor'
+      TTY::Cursor
+    end
+
+    # Open a file or text in the user's preferred editor
+    #
+    # @see http://www.rubydoc.info/gems/tty-editor
+    #
+    # @api public
+    def editor
+      require 'tty-editor'
+      TTY::Editor
+    end
+
+    # File manipulation utility methods
+    #
+    # @see http://www.rubydoc.info/gems/tty-file
+    #
+    # @api public
+    def generator
+      require 'tty-file'
+      TTY::File
+    end
+
+    # Terminal output paging
+    #
+    # @see http://www.rubydoc.info/gems/tty-pager
+    #
+    # @api public
+    def pager(**options)
+      require 'tty-pager'
+      TTY::Pager.new(options)
+    end
+
+    # Terminal platform and OS properties
+    #
+    # @see http://www.rubydoc.info/gems/tty-pager
+    #
+    # @api public
+    def platform
+      require 'tty-platform'
+      TTY::Platform.new
+    end
+
+    # The interactive prompt
+    #
+    # @see http://www.rubydoc.info/gems/tty-prompt
+    #
+    # @api public
+    def prompt(**options)
+      require 'tty-prompt'
+      TTY::Prompt.new(options)
+    end
+
+    # Get terminal screen properties
+    #
+    # @see http://www.rubydoc.info/gems/tty-screen
+    #
+    # @api public
+    def screen
+      require 'tty-screen'
+      TTY::Screen
+    end
+
+    # The unix which utility
+    #
+    # @see http://www.rubydoc.info/gems/tty-which
+    #
+    # @api public
+    def which(*args)
+      require 'tty-which'
+      TTY::Which.which(*args)
+    end
+
+    # Check if executable exists
+    #
+    # @see http://www.rubydoc.info/gems/tty-which
+    #
+    # @api public
+    def exec_exist?(*args)
+      require 'tty-which'
+      TTY::Which.exist?(*args)
+    end
+  end
+end

data/lib/boxybox/commands/.gitkeep

@@ -0,0 +1 @@
+#

data/lib/boxybox/commands/boxes.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative '../command'
+require 'boxybox/models/box_builder'
+
+module Boxybox
+  module Commands
+    class Boxes < Boxybox::Command
+      def initialize(input, options)
+        @input = input
+        @options = options
+      end
+
+      def execute(input: $stdin, output: $stdout)
+        json_str = @input
+
+        if @options['file']
+          file_path = @options['file']
+          json_str = IO.read(file_path)
+        elsif @options['example']
+          file_path = "lib/boxybox/templates/boxes/#{@options['example']}.json"
+          json_str = IO.read(file_path)
+          output.puts json_str if @options['print_example']
+        end
+
+        boxes = BoxBuilder.create_from_json(json_str)
+
+        # Command logic goes here ...
+        output.puts boxes
+      end
+    end
+  end
+end

data/lib/boxybox/models/box_builder.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'tty-box'
+
+# @author Travis Carter
+# helper methods to create and merge terminal boxes
+class BoxBuilder
+  SPACE = ' '
+
+  attr_accessor :direction, :children, :content
+
+  # @param [Object] config
+  # @return [BoxBuilder] new instance of BoxBuilder
+  def initialize(config)
+    @direction = config['direction']
+    @children = config['children']
+    @content = config['content']
+  end
+
+  # This kicks off the parsing of the input JSON and returns the nested boxes as a string
+  # @param [JSON] json_string input to create boxes
+  # @return [String] will return a multiline string of ascii boxes
+  def self.create_from_json(json_string)
+    config = JSON.parse(json_string)
+    box_builder = BoxBuilder.new(config['boxes'])
+
+    box_builder.create_boxes
+  end
+
+  # This is the recursive method that craws down the tree to create the boxes
+  # @return [Strings]
+  def create_boxes
+    unless @children.nil?
+      child_boxes = []
+
+      children.each { |child| child_boxes << BoxBuilder.new(child).create_boxes }
+
+      @content = if child_boxes.length > 1 && direction == 'horizontal'
+                   BoxBuilder.merge_boxes(*child_boxes)
+                 else
+                   child_boxes.join("\n")
+                 end
+    end
+
+    @content = make_box(@content)
+  end
+
+  # Wrapper around the TTY::Box module.  This will be a prime target for expanded style choices and using more of the
+  # customizations available within the TTY gem set
+  # @return [Strings] ascii box
+  def make_box(content)
+    TTY::Box.frame(content, padding: 1, border: :ascii)
+  end
+
+  # @param [Array] box_strings boxes to be merged
+  # @return [String]
+  def self.merge_boxes(*box_strings)
+    box_arrays = {}
+    max_rows = 0
+    new_box = []
+
+    box_strings.each_with_index do |box, idx|
+      box_arrays[idx] = box.split("\n")
+
+      max_rows = max_rows > box_arrays[idx].length ? max_rows : box_arrays[idx].length
+    end
+
+    max_rows.times do |x|
+      new_line = ''
+      box_arrays.each_value { |box| new_line += box[x].nil? ? SPACE * box.first.length : box[x] }
+
+      new_box << new_line
+    end
+
+    new_box.join("\n")
+  end
+end