priscilla 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a5cce59a7dc7bf7419147704a5be9de5ca419cc
-  data.tar.gz: c253d820579c8623962923d45d1adf8bd11c02b6
+  metadata.gz: 7a52af6acd6213eead9ab9d0581b19af86381905
+  data.tar.gz: 42ea159fc75993795fa444a3c6c3333ce936751b
 SHA512:
-  metadata.gz: 608f35c0a914ca795414d3203b4271f361792735e936af124ae38512e9a00dd99d47cf993488a1b9a92259cfc47012b800fe86d0772e6b162556ce210e159358
-  data.tar.gz: f44d2a52cbba062e64f170cf67bf8789b93aaf3538d154964fb0a9caad0ec2dc2846f859b46b1178b1d0935f80a10b6eb4713aab2b20d8837c50fd7370b3ebfd
+  metadata.gz: 55fa690da61390f5218daa78dea194489fd47f3e4f0d44e12a88a64765a0e98d95f36e0490b0eafae831bfa57fa96762104a396d8f41727fd5549e6167793684
+  data.tar.gz: c7daa595dac5813bb9e4f895b29034291c8591ce7eec7f0bea21f2e38947c0ac9c285dfe1120a2fe1493a7934214aeb5818a821c08c367a69f4bf50cef1fa218

data/README.md

@@ -1,8 +1,15 @@
 # Priscilla
 
-TODO: Write a gem description
+Frock up your console messages. :dancer: :dancer: :dancer:
 
-## Installation
+## Why Priscilla
+
+Because of Priscilla, Queen of the Desert. Don't let your console messages drown
+in a wall of text, make them stand out!
+
+![Tutorial](images/priscilla.gif)
+
+## Install
 
 Add this line to your application's Gemfile:
 
@@ -16,13 +23,55 @@ Or install it yourself as:
 
     $ gem install priscilla
 
-## Usage
+## Use
+
+Require the gem:
+
+    require 'priscilla'
+
+Use `pr` to frock up your console messages
+
+    pr "A cock in a frock on a rock"
+
+Result
+
+![Result](images/result.png)
+
+## Decorators
+
+Priscilla supports a lot of different decorators:
+
+**Strings**
+
+![Strings](images/strings.png)
+
+**Colored Strings**
+
+![Colored Strings](images/colored_strings.png)
+![Colored Strings, part 2](images/colored_strings_two.png)
+
+**Unicode Emojis**
+
+![Unicode Emojis](images/unicode_emojis.rb)
+
+**Text Emojis**
+
+![Text Emojis](images/text_emojis.rb)
+
+## Configure
+
+If you're using rails create an initializer in `config/initializers/priscilla.rb`:
 
-TODO: Write usage instructions here
+```ruby
+Priscilla.configure do |c|
+  c.width = 80              # default
+  c.decorator = ':dancer: ' # default
+end
+```
 
-## Contributing
+## Contribute
 
-1. Fork it ( http://github.com/<my-github-username>/priscilla/fork )
+1. Fork it ( http://github.com/Arkham/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`)

data/lib/priscilla.rb

@@ -1,8 +1,19 @@
 require 'colorize'
 
-require "priscilla/version"
-require "priscilla/configuration"
-require "priscilla/makeup"
+require 'priscilla/version'
+require 'priscilla/simple_emoji'
+require 'priscilla/configuration'
+require 'priscilla/makeup'
+
+module Priscilla
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end
 
 module Kernel
   def pr(message, **options)

data/lib/priscilla/configuration.rb

@@ -1,21 +1,24 @@
 module Priscilla
-  def self.configuration
-    @configuration ||= Configuration.new
-  end
-
-  def self.configure
-    yield(configuration)
-  end
-
   class Configuration
     DEFAULT_WIDTH = 80
-    DEFAULT_DECORATOR = "⚡ ".on_blue
+    DEFAULT_DECORATOR = ':dancer: '
 
     attr_accessor :width, :decorator
 
     def initialize
-      @width = DEFAULT_WIDTH
-      @decorator = DEFAULT_DECORATOR
+      self.width = DEFAULT_WIDTH
+      self.decorator = DEFAULT_DECORATOR
+    end
+
+    def decorator=(value)
+      @decorator = emojify(value)
+    end
+
+  private
+
+    def emojify(value)
+      value = ":#{value}: " if value.is_a? Symbol
+      SimpleEmoji.convert(value)
     end
   end
 end

data/lib/priscilla/makeup.rb

@@ -13,7 +13,7 @@ module Priscilla
     def decorate(message, **options)
       override_config(options)
       message = message.to_s
-      [ decorated_line, decorate_message(message), decorated_line ].join("\n")
+      [decorated_line, decorate_message(message), decorated_line].join("\n")
     end
 
   private
@@ -31,16 +31,16 @@ module Priscilla
     end
 
     def decoratable?(message)
-      minimum_decorated_length(message) <= decoratable_width
+      min_decorated_length(message) <= decoratable_width
     end
 
-    def minimum_decorated_length(message)
+    def min_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))
+      padding = space_for(decoratable_width - min_decorated_length(message))
       "#{decorator} #{message} #{padding}#{decorator}"
     end
 

data/lib/priscilla/simple_emoji.rb

@@ -0,0 +1,9 @@
+require 'rumoji'
+
+class SimpleEmoji
+  class << self
+    def convert(string)
+      Rumoji.decode(string)
+    end
+  end
+end

data/lib/priscilla/version.rb

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

data/priscilla.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   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.summary       = %q{Frock up your console messages}
+  spec.description   = %q{Don't let your console messages drown in a wall of text, make them stand out}
   spec.homepage      = "http://github.com/Arkham/priscilla"
   spec.license       = "MIT"
 
@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "colorize", "~> 0.7"
+  spec.add_dependency "rumoji", "~> 0.3"
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake", "~> 10.1"

data/spec/priscilla/configuration_spec.rb

@@ -1,20 +1,46 @@
 require 'spec_helper'
 
 describe Priscilla do
-  describe "::configure" do
-    before do
+  describe '::configure' do
+    it 'allows to configure options' do
       Priscilla.configure do |c|
         c.width = 5
-        c.decorator = "*"
+        c.decorator = '*'
       end
-    end
 
-    it "allows to configure options" do
-      expect(capture_stdout { pr("1") }).to eq(
+      expect(capture_stdout { pr('∆') }).to eq(
         "*****\n" +
-        "* 1 *\n" +
+        "* ∆ *\n" +
         "*****\n\n"
       )
     end
+
+    context "emoji" do
+      it 'converts decorator symbols to emoji' do
+        Priscilla.configure do |c|
+          c.width = 8
+          c.decorator = :zap
+        end
+
+        expect(capture_stdout { pr(':)') }).to eq(
+          "⚡ ⚡ ⚡ ⚡ \n" +
+          "⚡  :) ⚡ \n" +
+          "⚡ ⚡ ⚡ ⚡ \n\n"
+        )
+      end
+
+      it 'converts emoji within strings' do
+        Priscilla.configure do |c|
+          c.width = 24
+          c.decorator = ':zap: :dancer: :no_good: :frog: '
+        end
+
+        expect(capture_stdout { pr("DO IT") }).to eq(
+          "⚡ 💃 🙅 🐸 ⚡ 💃 🙅 🐸 ⚡ 💃 🙅 🐸 \n" +
+          "⚡ 💃 🙅 🐸  DO IT  ⚡ 💃 🙅 🐸 \n" +
+          "⚡ 💃 🙅 🐸 ⚡ 💃 🙅 🐸 ⚡ 💃 🙅 🐸 \n\n"
+        )
+      end
+    end
   end
 end

data/spec/priscilla/makeup_spec.rb

@@ -6,12 +6,12 @@ module Priscilla
     describe "#decorate" do
       let(:width) { 35 }
       let(:decorator) { "=" }
-      let(:config) {
+      let(:config) do
         OpenStruct.new(
           width: width,
           decorator: decorator
         )
-      }
+      end
 
       subject do
         described_class.new(config)
@@ -92,6 +92,18 @@ module Priscilla
           expect(old_config.decorator).not_to eq(subject.config.decorator)
         end
       end
+
+      context "when an unicode emoji is passed" do
+        let(:decorator) { "⚡ " }
+
+        it "tries to convert it to an unicode emoji" do
+          expect(output).to eq(
+            "⚡ ⚡ ⚡ ⚡ ⚡ ⚡ ⚡ ⚡ ⚡ ⚡ ⚡ ⚡ ⚡ ⚡ ⚡ ⚡ ⚡ \n" +
+            "⚡  A cock in a frock on a rock  ⚡ \n" +
+            "⚡ ⚡ ⚡ ⚡ ⚡ ⚡ ⚡ ⚡ ⚡ ⚡ ⚡ ⚡ ⚡ ⚡ ⚡ ⚡ ⚡ "
+          )
+        end
+      end
     end
   end
 end

data/spec/priscilla/simple_emoji_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe SimpleEmoji do
+  describe "::convert" do
+    let(:emoji) { SimpleEmoji.convert(string) }
+
+    context "when emoji is found" do
+      let(:string) { ':zap:' }
+
+      it 'translates a string to an emoji' do
+        expect(emoji).to eq("⚡")
+      end
+    end
+
+    context "when no emoj is found" do
+      let(:string) { 'something_completely_different' }
+
+      it 'returns it unchanged' do
+        expect(emoji).to eq(string)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: priscilla
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Ju Liu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-27 00:00:00.000000000 Z
+date: 2014-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rumoji
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +80,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
-description: Make your messages stand out from the crowd
+description: Don't let your console messages drown in a wall of text, make them stand
+  out
 email:
 - ju.liu@welaika.com
 executables: []
@@ -82,10 +97,12 @@ files:
 - lib/priscilla.rb
 - lib/priscilla/configuration.rb
 - lib/priscilla/makeup.rb
+- lib/priscilla/simple_emoji.rb
 - lib/priscilla/version.rb
 - priscilla.gemspec
 - spec/priscilla/configuration_spec.rb
 - spec/priscilla/makeup_spec.rb
+- spec/priscilla/simple_emoji_spec.rb
 - spec/priscilla_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/Arkham/priscilla
@@ -111,9 +128,11 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Frock up your messages
+summary: Frock up your console messages
 test_files:
 - spec/priscilla/configuration_spec.rb
 - spec/priscilla/makeup_spec.rb
+- spec/priscilla/simple_emoji_spec.rb
 - spec/priscilla_spec.rb
 - spec/spec_helper.rb
+has_rdoc: