talking 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 805d840951ca51ae671a94407b05878786b3a15e
+  data.tar.gz: 09902d4d942a7ac47cdcd365ace8378fd345d9ce
+SHA512:
+  metadata.gz: 24fcca654189b8b68d88cec0836e930ef283cda223601a65ab9b609d3b80d1187138dc233d9b176f732b2192910f588d4688d8c8f02ecb0728d9abc0fe9f6a68
+  data.tar.gz: 5366a8c4f42eb5d8e37f57d9fae3e28d2149521760ae3ea71f47941a96db437768de7533f7137ae1856af0f95626ac16043b45ba0080fb6faabb17100f6fee4d

data/.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in talking.gemspec
+gemspec

data/README.md

@@ -0,0 +1,67 @@
+# Talking
+
+Simple talking module for your programs. Don't confuse it with logging. It's not logging. It's just
+the simplest possible module that allows your application to speak two kinds of messages, natural (standard) and (debug). It's easily configurable and embeddable into your stuff.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'talking'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install talking
+
+## Usage
+
+Give voice to your class or module:
+
+```ruby
+require 'talking'
+
+class Person
+  include Talking::Talkative
+end
+
+borat = Person.new
+borat.say('Hello!')
+borat.debug('This is niiiice!')
+```
+
+The outputs can be configured using either stream, null or custom voices. Here are defaults:
+
+```ruby
+Person.mouth.natural_voice = Talking::StreamVoice.new(STDERR)
+Person.mouth.debug_voice = Talking::NullVoice.instance
+```
+
+Debug mode is actually automatic, whenever you provide `DEBUG` environment variable set to `1`
+it will automatically set stream voice for debugging, otherwise the null one will be used. In the
+end code we have something like this, so you can have an idea:
+
+```ruby
+def mouth
+  @mouth ||= Mouth.new(
+    StreamVoice.new(STDERR),
+    ENV['DEBUG'] == '1' ? StreamVoice.new(STDERR) : NullVoice.instance
+  )
+end
+```
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/talking.
+

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 "talking"
+
+# 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

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/talking/version.rb

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

data/lib/talking.rb

@@ -0,0 +1,51 @@
+require "talking/version"
+require "forwardable"
+require "singleton"
+
+# Public: A talking module. It allows our program to verbosely tell us what he does while
+# performing stuff around.
+module Talking
+  # Public: Silence. Mutes our poor program.
+  class NullVoice
+    include Singleton
+
+    def puts(msg, *args)
+    end
+  end
+
+  # Public: Simple to-stream output voice. It prints stuff up to initialized IO.
+  StreamVoice = Struct.new(:stream) do
+    def puts(msg, *args)
+      stream.puts(format(msg, *args))
+    end
+  end
+
+  # Public: Your program should use mouth to speak stuff. Give him this ones.
+  Mouth = Struct.new(:natural_voice, :debug_voice) do
+    # Public: Says simple stuff with formatted parameters.
+    def say(msg, *args)
+      natural_voice.puts(msg, *args)
+    end
+
+    # Public: Debug information print. Uses secondary, debug voice output.
+    def debug(msg, *args)
+      debug_voice.puts("DEBUG: #{msg}", *args)
+    end
+  end
+
+  # Public: Incldue this stuff into your class to make it talkative.
+  module Talkative
+    def self.included(klass)
+      klass.extend(Forwardable)
+      klass.delegate([:say, :debug] => :mouth)
+    end
+
+    # Public: Configured mouth object.
+    def mouth
+      @mouth ||= Mouth.new(
+        StreamVoice.new(STDERR),
+        ENV['DEBUG'] == '1' ? StreamVoice.new(STDERR) : NullVoice.instance
+      )
+    end
+  end
+end

data/talking.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'talking/version'
+
+Gem::Specification.new do |spec|
+  spec.name = "talking"
+  spec.version = Talking::VERSION
+  spec.authors = ["Kris Kovalik"]
+  spec.email = ["hi@kkvlk.me"]
+
+  spec.summary = %q{Wanna teach your app talking a little?}
+  spec.description = %q{This tiny library provides simple talking module for command line apps.}
+  spec.homepage = "https://github.com/kkvlk/talking"
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: talking
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kris Kovalik
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This tiny library provides simple talking module for command line apps.
+email:
+- hi@kkvlk.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/talking.rb
+- lib/talking/version.rb
+- talking.gemspec
+homepage: https://github.com/kkvlk/talking
+licenses: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Wanna teach your app talking a little?
+test_files: []