termiro 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9844ab20b8030a92b2b61a1b2254bb5ddb3effcb85d44a1f269e4029506c19e0
+  data.tar.gz: 9a452ccf07e8dd8224c10546b5dff8e68976bf15f67fd5ccb41cfb6289f2fc9a
+SHA512:
+  metadata.gz: 478341f01e0d7e02c7cd380bb1dd16d16e8258adb27fd1b6a255bdf89b3c075d8deafba3ae7cc95f3ce091f245b1b9b37f9baf7fe56c222f1e8c06da70e9642c
+  data.tar.gz: 9e0726b6862457e7022d3daa0b34e23a989c7cc36a1e4a32076f4bdd3a4a1e6390c5c5328b82c3e0eb1f3cff9b48d9d579d6b900dc672e5753a553959bc498fd

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock
+
+notes.txt
+
+.ruby-version
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at josemanuqln.88@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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 termiro.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Jose Quinones
+
+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,111 @@
+![logo](logo.png)
+
+Termiro helps you to add colorful titles and graphics to your CLI apps.
+
+While working on a few personal projects like [battle_ship](https://github.com/jo-quin/battle_ship) where I added graphics and messages to enhance the user experience, I found a convenient way to create and display 8-bit looking images.
+
+Now I have extracted this code into a Ruby Gem which makes it easy to use in future apps and easy to share with the community.
+Termiro is an [open source](#license) project, therefore, everyone is welcome to use it and [contribute](#contributing).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'termiro'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install termiro
+
+## Usage
+
+Once Termiro is [installed](#installation) in your project create a folder called 'graphics' on your main working directory.
+
+```
+mkdir graphics
+```
+
+Termiro will look on this folder to find your drawings.
+
+Then create a text file inside the graphics folder and start to draw!
+
+```
+touch graphics/my_drawing.txt
+```
+
+To print the drawing from your app you need to first require Termiro.
+
+```
+require 'termiro'
+```
+
+Then use Termiro's draw method passing the name of your drawing as an argument.
+
+```
+Termiro.draw('my_drawing')
+``` 
+
+## How to draw using Termiro
+
+Drawing in Termiro is like filling little squares with whenever color you choose.
+
+Every square is really a whitespace and Termiro simply changes the background color of these whitespace.
+
+In your text file you write 'r' for red and Termiro will change the character 'r' for a whitespace with a red background.
+
+The color codes are the following:
+
+- r -> red
+
+- y -> yellow
+
+- b -> blue
+
+- g -> green
+
+- m -> magenta
+
+- c -> cyan
+
+- w -> white
+
+- x -> black
+
+For an empty space Termiro uses the '-' (minus) character.
+
+As an example follow the steps on [Usage](#usage) section to create an empty .txt file in your project and copy paste the following text:
+
+```
+-------------
+----rrrr-----
+---rrwwrr----
+---yxyyxy-ww-
+---yyxxyy-rr-
+-rrbbrrbbrr--
+-rrbybbyb----
+-wwbbbbbb----
+---bb--bb----
+--rrr--rrr---
+-------------
+```
+
+Say hi to Mario! :)
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jo-quin/termiro. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Termiro project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jo-quin/termiro/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,30 @@
+require "termiro/version"
+
+module Termiro
+  class Error < StandardError; end
+  
+  COLORS = { r: "\u001b[41m \u001b[0m", 
+  y: "\u001b[43m \u001b[0m",
+  b: "\u001b[44m \u001b[0m", 
+  g: "\u001b[42m \u001b[0m",
+  m: "\u001b[45m \u001b[0m",
+  c: "\u001b[46m \u001b[0m",
+  w: "\u001b[47m \u001b[0m", 
+  x: "\u001b[40m \u001b[0m"}
+
+  def self.draw(file)
+    graphic = ""
+    lines= File.readlines("graphics/#{file}.txt")
+    lines.each do |line|
+      line.each_char do |color|
+        if color == '-' # if character not int colors
+          graphic += ' '
+        else
+          graphic += COLORS[color.to_sym].to_s
+        end
+      end
+      graphic += "\n"
+    end
+    puts graphic
+  end
+end

data/lib/termiro/version.rb

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

data/termiro.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "termiro/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "termiro"
+  spec.version       = Termiro::VERSION
+  spec.authors       = ["Jose Quinones"]
+  spec.email         = ["josemanuelqn.88@gmail.com"]
+
+  spec.summary       = %q{Draw awesome art in your terminal.}
+  spec.homepage      = "https://github.com/jo-quin/termiro"
+  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_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: termiro
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jose Quinones
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-28 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: 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'
+description: 
+email:
+- josemanuelqn.88@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/termiro.rb
+- lib/termiro/version.rb
+- logo.png
+- termiro.gemspec
+homepage: https://github.com/jo-quin/termiro
+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.3
+signing_key: 
+specification_version: 4
+summary: Draw awesome art in your terminal.
+test_files: []