priscilla 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2a5cce59a7dc7bf7419147704a5be9de5ca419cc
+  data.tar.gz: c253d820579c8623962923d45d1adf8bd11c02b6
+SHA512:
+  metadata.gz: 608f35c0a914ca795414d3203b4271f361792735e936af124ae38512e9a00dd99d47cf993488a1b9a92259cfc47012b800fe86d0772e6b162556ce210e159358
+  data.tar.gz: f44d2a52cbba062e64f170cf67bf8789b93aaf3538d154964fb0a9caad0ec2dc2846f859b46b1178b1d0935f80a10b6eb4713aab2b20d8837c50fd7370b3ebfd

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ju Liu
+
+MIT License
+
+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,29 @@
+# Priscilla
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'priscilla'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install priscilla
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/priscilla/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/priscilla/configuration.rb

@@ -0,0 +1,21 @@
+module Priscilla
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  class Configuration
+    DEFAULT_WIDTH = 80
+    DEFAULT_DECORATOR = "⚡ ".on_blue
+
+    attr_accessor :width, :decorator
+
+    def initialize
+      @width = DEFAULT_WIDTH
+      @decorator = DEFAULT_DECORATOR
+    end
+  end
+end

data/lib/priscilla/makeup.rb

@@ -0,0 +1,62 @@
+require 'forwardable'
+
+module Priscilla
+  class Makeup
+    extend Forwardable
+    attr_reader :config
+    def_delegators :@config, :width, :decorator
+
+    def initialize(config)
+      @config = config.clone
+    end
+
+    def decorate(message, **options)
+      override_config(options)
+      message = message.to_s
+      [ decorated_line, decorate_message(message), decorated_line ].join("\n")
+    end
+
+  private
+
+    def decorator_length
+      decorator.uncolorize.length
+    end
+
+    def decoratable_width
+      (width / decorator_length) * decorator_length
+    end
+
+    def decorated_line
+      decorator * (decoratable_width / decorator_length)
+    end
+
+    def decoratable?(message)
+      minimum_decorated_length(message) <= decoratable_width
+    end
+
+    def minimum_decorated_length(message)
+      # add two decorators and two wrapping spaces
+      message.length + (decorator_length * 2) + 2
+    end
+
+    def message_template(message)
+      padding = space_for(decoratable_width - minimum_decorated_length(message))
+      "#{decorator} #{message} #{padding}#{decorator}"
+    end
+
+    def space_for(times)
+      ' ' * times
+    end
+
+    def decorate_message(message)
+      return message unless decoratable?(message)
+      message_template(message)
+    end
+
+    def override_config(options)
+      options.each do |key, value|
+        config.send("#{key}=", value)
+      end
+    end
+  end
+end

data/lib/priscilla/version.rb

@@ -0,0 +1,3 @@
+module Priscilla
+  VERSION = "0.0.1"
+end

data/lib/priscilla.rb

@@ -0,0 +1,12 @@
+require 'colorize'
+
+require "priscilla/version"
+require "priscilla/configuration"
+require "priscilla/makeup"
+
+module Kernel
+  def pr(message, **options)
+    puts Priscilla::Makeup.new(Priscilla.configuration).decorate(message, options)
+    puts
+  end
+end

data/priscilla.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'priscilla/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "priscilla"
+  spec.version       = Priscilla::VERSION
+  spec.authors       = ["Ju Liu"]
+  spec.email         = ["ju.liu@welaika.com"]
+  spec.summary       = %q{Frock up your messages}
+  spec.description   = %q{Make your messages stand out from the crowd}
+  spec.homepage      = "http://github.com/Arkham/priscilla"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "colorize", "~> 0.7"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 10.1"
+  spec.add_development_dependency "rspec", "~> 2.14"
+end

data/spec/priscilla/configuration_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Priscilla do
+  describe "::configure" do
+    before do
+      Priscilla.configure do |c|
+        c.width = 5
+        c.decorator = "*"
+      end
+    end
+
+    it "allows to configure options" do
+      expect(capture_stdout { pr("1") }).to eq(
+        "*****\n" +
+        "* 1 *\n" +
+        "*****\n\n"
+      )
+    end
+  end
+end

data/spec/priscilla/makeup_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+require 'ostruct'
+
+module Priscilla
+  describe Makeup do
+    describe "#decorate" do
+      let(:width) { 35 }
+      let(:decorator) { "=" }
+      let(:config) {
+        OpenStruct.new(
+          width: width,
+          decorator: decorator
+        )
+      }
+
+      subject do
+        described_class.new(config)
+      end
+
+      let(:message) { "A cock in a frock on a rock" }
+      let(:output) { subject.decorate(message) }
+
+      it "makes a nice header around the message" do
+        expect(output).to eq(
+          "===================================\n" +
+          "= A cock in a frock on a rock     =\n" +
+          "==================================="
+        )
+      end
+
+      context "when passed a non-string" do
+        let(:width) { 7 }
+        let(:message) { 450 }
+
+        it "converts to string and decorates" do
+          expect(output).to eq(
+            "=======\n" +
+            "= 450 =\n" +
+            "======="
+          )
+        end
+      end
+
+      context "when message is longer than given width" do
+        let(:message) { "My name is Inigo Montoya, you killed my father, prepare to die" }
+
+        it "does not decorate the message" do
+          expect(output).to eq(
+            "===================================\n" +
+            "My name is Inigo Montoya, you killed my father, prepare to die\n" +
+            "==================================="
+          )
+        end
+      end
+
+      context "when decorator is more than a single character" do
+        let(:decorator) { "<>" }
+
+        it "scales the decoration accordingly" do
+          expect(output).to eq(
+            "<><><><><><><><><><><><><><><><><>\n" +
+            "<> A cock in a frock on a rock  <>\n" +
+            "<><><><><><><><><><><><><><><><><>"
+          )
+        end
+      end
+
+      context "when decorator is a colorized string" do
+        let(:decorator) { "[]".blue }
+
+        it "ignores the colors to calculate the total width" do
+          expect(output.uncolorize).to eq(
+            "[][][][][][][][][][][][][][][][][]\n" +
+            "[] A cock in a frock on a rock  []\n" +
+            "[][][][][][][][][][][][][][][][][]"
+          )
+        end
+      end
+
+      context "when options are passed" do
+        it "prefers them over the default configuration" do
+          expect(subject.decorate(message, decorator: "€")).to eq(
+            "€€€€€€€€€€€€€€€€€€€€€€€€€€€€€€€€€€€\n" +
+            "€ A cock in a frock on a rock     €\n" +
+            "€€€€€€€€€€€€€€€€€€€€€€€€€€€€€€€€€€€"
+          )
+        end
+
+        it "does not override the default configuration" do
+          old_config = config
+          subject.decorate(message, decorator: "¬_¬")
+          expect(old_config.decorator).not_to eq(subject.config.decorator)
+        end
+      end
+    end
+  end
+end
+

data/spec/priscilla_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Priscilla do
+  describe "::pr" do
+    it "adds a method to the Kernel" do
+      expect(capture_stdout { pr("hello") }).to match(/hello/)
+    end
+
+    it "forwards additional options" do
+      expect(capture_stdout { pr("hello", decorator: '<3') }).to match(/hello/)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'priscilla'
+
+module CaptureHelpers
+  def capture_stdout(&block)
+    original_stdout = $stdout
+    $stdout = fake = StringIO.new
+    begin
+      yield
+    ensure
+      $stdout = original_stdout
+    end
+    fake.string
+  end
+end
+
+RSpec.configure do |config|
+  config.include CaptureHelpers
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: priscilla
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ju Liu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: Make your messages stand out from the crowd
+email:
+- ju.liu@welaika.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/priscilla.rb
+- lib/priscilla/configuration.rb
+- lib/priscilla/makeup.rb
+- lib/priscilla/version.rb
+- priscilla.gemspec
+- spec/priscilla/configuration_spec.rb
+- spec/priscilla/makeup_spec.rb
+- spec/priscilla_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/Arkham/priscilla
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Frock up your messages
+test_files:
+- spec/priscilla/configuration_spec.rb
+- spec/priscilla/makeup_spec.rb
+- spec/priscilla_spec.rb
+- spec/spec_helper.rb