cork 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f69595883925c08a5f98b7efc4a3ad1cf121ed6e
+  data.tar.gz: 210dc43c15f92df038158ee8b1c2eb68f1b14274
+SHA512:
+  metadata.gz: 13fb39df2ac37a8029147de9e138a40a68581d0e192f29525d967c2e5716b6494ed98a950138aa19b6221a277724d07d7ceea469b620cdc77064b02d70e777dc
+  data.tar.gz: 8357f4c295ea96d1137a187536b85cd55fd5e0a7cbb0f8e04b9e45fd32baad4711a5523031ca16efe415fa8dd82d6df25db354ee5bfd1474f3e95c0357db8950

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## Master
+
+This version is extracted from CocoaPods.

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 
+
+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,55 @@
+# Cork
+
+A delightful CLI UI module.
+
+## Usage
+
+```ruby
+board = Cork::Board.new()
+```
+
+You can use Cork to print simple messages.
+
+```ruby
+board.puts('Hello World')
+```
+
+You can use notice to print notices to the user colored in green.
+
+```ruby
+board.notice("We're out of 🍷.")
+```
+
+This is an example of Cork used to build a simple list.
+
+```ruby
+board.section('Types of Wine') do
+  board.labeled('Red', ['Shiraz', 'Merlot'])
+  board.labeled('White', ['Gewürztraminer', 'Riesling'])
+end
+```
+
+```
+Types of Wine
+  - Red:
+    - Shiraz
+    - Merlot
+  - White:
+    - Gewürztraminer
+    - Riesling
+```
+
+This is an example of Cork used to print a warning with actions the user can take.
+
+```ruby
+board.warn('Merlot is down to 1 oz', [
+  'Purchase some more.'
+])
+
+board.print_warnings
+```
+
+```
+[!] Merlot is down to 1 oz
+    - Purchase some more.
+```

data/lib/cork.rb

@@ -0,0 +1,5 @@
+module Cork
+  require 'cork/board'
+  require 'cork/gem_version'
+  require 'cork/text_wrapper'
+end

data/lib/cork/board.rb

@@ -0,0 +1,348 @@
+require 'colored'
+
+module Cork
+  # provides support for UI output. Cork provides support for nested
+  # sections of information and for a verbose mode.
+  #
+
+  class Board
+    # @return [input] The input specification that contains the user input
+    #          for the UI.
+    #
+    attr_reader :input
+    # @return [output] The output specification containing the UI output.
+    attr_reader :out
+    # @return [error] The error specification containing the UI error.
+    attr_reader :err
+    # @return [warnings] The warnings specification containing the UI warnings.
+    attr_reader :warnings
+    # @return [Bool] Whether the wrapping of the strings to the width of the
+    #         terminal should be disabled.
+    #
+    attr_accessor :disable_wrap
+    alias_method :disable_wrap?, :disable_wrap
+
+    attr_reader :verbose
+    alias_method :verbose?, :verbose
+
+    attr_reader :silent
+    alias_method :silent?, :silent
+
+    attr_reader :ansi
+    alias_method :ansi?, :ansi
+
+    attr_accessor :indentation_level
+    attr_accessor :title_level
+
+    # Initialize a new instance.
+    #
+    # @param [Boolean] verbose When verbose is true verbose output is printed.
+    #        this defaults to true
+    # @param [Boolean] silent When silent is true all output is supressed.
+    #        This defaults to false.
+    # @param [Boolean] ansi When ansi is true output may contain ansi
+    #        color codes. This is true by default.
+    # @param [IO] input The file descriptor to read the user input.
+    # @param [IO] out The file descriptor to print all output to.
+    # @param [IO] err The file descriptor to print all errors to.
+    #
+    def initialize(verbose: false, silent: false, ansi: true,
+      input: $stdin, out: $stdout, err: $stderr)
+
+      @input = input
+      @out = out
+      @err = err
+      @verbose = verbose
+      @silent = silent
+      @ansi = ansi
+      @warnings = []
+      @title_colors      =  %w(    yellow green    )
+      @title_level       =  0
+      @indentation_level =  2
+    end
+
+    # Prints a message followed by a new line unless silent.
+    #
+    def puts(message = '')
+      out.puts(message) unless silent?
+    end
+
+    # Prints a message without a new line unless silent.
+    #
+    def print(message)
+      out.print(message) unless silent?
+    end
+
+    # Prints a message respecting the current indentation level and
+    # wrapping it to the terminal width if necessary.
+    #
+    def puts_indented(message = '')
+      indented = wrap_string(message, @indentation_level)
+      puts(indented)
+    end
+
+    # Gets input from the configured input.
+    #
+    def gets
+      input.gets
+    end
+
+    # Stores important warning to the user optionally followed by actions that
+    # the user should take. To print them use {#print_warnings}.
+    #
+    #  @param [String]  message The message to print.
+    #  @param [Array]   actions The actions that the user should take.
+    #  @param [Boolean] verbose_only When verbose_only is configured to
+    #                   true, the warning will only be printed when
+    #                   Board is configured to print verbose messages.
+    #                   This is false by default.
+    #
+    #  @return [void]
+    #
+    def warn(message, actions = [], verbose_only = false)
+      warnings << {
+        :message      => message,
+        :actions      => actions,
+        :verbose_only => verbose_only,
+      }
+    end
+
+    # The returned path is quoted. If the argument is nil it returns an empty
+    # string.
+    #
+    # @param [#to_str,Nil] pathname
+    #        The path to return.
+    # @param [Pathname] relative_to
+    #
+    def path(pathname, relative_to = Pathname.pwd)
+      if pathname
+        path = Pathname(pathname).relative_path_from(relative_to)
+        "`#{path}`"
+      else
+        ''
+      end
+    end
+
+    # Prints a message with a label.
+    #
+    # @param [String] label
+    #        The label to print.
+    #
+    # @param [#to_s] value
+    #        The value to print.
+    #
+    # @param [FixNum] justification
+    #        The justification of the label.
+    #
+    def labeled(label, value, justification = 12)
+      if value
+        title = "- #{label}:"
+        if value.is_a?(Enumerable)
+          lines = [wrap_string(title, indentation_level)]
+          lines += value.map do |v|
+            wrap_string("- #{v}", indentation_level + 2)
+          end
+          puts lines.join("\n")
+        else
+          string = title.ljust(justification) + "#{value}"
+          puts wrap_string(string, indentation_level)
+        end
+      end
+    end
+
+    # Prints a title taking an optional verbose prefix and
+    # a relative indentation valid for the UI action in the passed
+    # block.
+    #
+    # In verbose mode titles are printed with a color according
+    # to their level. In normal mode titles are printed only if
+    # they have nesting level smaller than 2.
+    #
+    # @todo Refactor to title (for always visible titles like search)
+    #       and sections (titles that represent collapsible sections).
+    #
+    # @param [String] title
+    #        The title to print
+    #
+    # @param [String] verbose_prefix
+    #        See #message
+    #
+    # @param [FixNum] relative_indentation
+    #        The indentation level relative to the current,
+    #        when the message is printed.
+    #
+    def section(title, verbose_prefix = '', relative_indentation = 0,
+                titled = false)
+      if verbose?
+        title(title, verbose_prefix, relative_indentation)
+      elsif title_level < 1 || titled
+        puts title
+      end
+
+      @indentation_level += relative_indentation
+      @title_level += 1
+      yield if block_given?
+      @indentation_level -= relative_indentation
+      @title_level -= 1
+    end
+
+    # Prints an info to the user. The info is always displayed.
+    # It respects the current indentation level only in verbose
+    # mode.
+    #
+    # Any title printed in the optional block is treated as a message.
+    #
+    # @param [String] message
+    #        The message to print.
+    #
+    def info(message)
+      indentation = verbose? ? @indentation_level : 0
+      indented = wrap_string(message, indentation)
+      puts(indented)
+
+      if block_given?
+        @indentation_level += 2
+        @treat_titles_as_messages = true
+        yield
+        @treat_titles_as_messages = false
+        @indentation_level -= 2
+      end
+    end
+
+    # A title opposed to a section is always visible
+    #
+    # @param [String] title
+    #         The title to print
+    #
+    # @param [String] verbose_prefix
+    #         See #message
+    #
+    # @param [FixNum] relative_indentation
+    #         The indentation level relative to the current,
+    #         when the message is printed.
+    #
+    def title(title, verbose_prefix = '', relative_indentation = 2)
+      if @treat_titles_as_messages
+        message(title, verbose_prefix)
+      else
+        puts_title(title, verbose_prefix)
+      end
+
+      if block_given?
+        @indentation_level += relative_indentation
+        @title_level += 1
+        yield
+        @indentation_level -= relative_indentation
+        @title_level -= 1
+      end
+    end
+
+    # Prints a verbose message taking an optional verbose prefix and
+    # a relatvie indentation valid for the UI action in the passed block.
+    #
+    def notice(message)
+      line = "\n[!] #{message}"
+      line = line.green if ansi?
+      puts(line)
+    end
+
+    # @todo Clean interface.
+    #
+    # @param [String] message
+    #       The message to print.
+    #
+    # @param [String] verbose_prefix
+    #        See #message
+    #
+    # @param [FixNum] relative_indentation
+    #         The indentation level relative to the current,
+    #         when the message is printed.
+    #
+
+    # Prints the stored warnings. This method is intended to be called at the
+    # end of the execution of the binary.
+    #
+    # @return [void]
+    #
+    def print_warnings
+      out.flush
+      warnings.each do |warning|
+        next if warning[:verbose_only] && !verbose?
+
+        message = "\n[!] #{warning[:message]}"
+        message = message.yellow if ansi?
+        err.puts(message)
+
+        warning[:actions].each do |action|
+          string = "- #{action}"
+          string = wrap_string(string, 4)
+          err.puts(string)
+        end
+      end
+    end
+
+    # Prints a verbose message taking an optional verbose prefix and
+    # a relative indentation valid for the UI action in the passed
+    # block.
+    #
+    # @todo Clean interface.
+    #
+    def message(message, verbose_prefix = '', relative_indentation = 2)
+      message = verbose_prefix + message if verbose?
+      puts_indented message if verbose?
+
+      @indentation_level += relative_indentation
+      yield if block_given?
+      @indentation_level -= relative_indentation
+    end
+
+    private
+
+    # @!group Helpers
+
+    attr_writer :indentation_level
+    attr_accessor :title_level
+
+    # Prints a title taking an optional verbose prefix and
+    # a relative indentation valid for the UI action in the passed
+    # block.
+    #
+    # In verbose mode titles are printed with a color according
+    # to their level. In normal mode titles are printed only if
+    # they have nesting level smaller than 2.
+    #
+    # @todo Refactor to title (for always visible titles like search)
+    #       and sections (titles that represent collapsible sections).
+    #
+    # @param [String] title
+    #        The title to print
+    #
+    # @param [String] verbose_prefix
+    #        See #message
+    #
+    # @param [FixNum] relative_indentation
+    #        The indentation level relative to the current,
+    #        when the message is printed.
+    #
+
+    def wrap_string(string, indent = 0)
+      first_space = ' ' * indent
+      if disable_wrap
+        first_space << string
+      else
+        columns = out.winsize[1]
+        indented = TextWrapper.wrap_with_indent(string, indent, columns)
+        first_space << indented
+      end
+    end
+
+    def puts_title(title, verbose_prefix)
+      title = verbose_prefix + title if verbose?
+      title = "\n#{title}" if @title_level < 2
+      if ansi? && (color = @title_colors[title_level])
+        title = title.send(color)
+      end
+      puts "#{title}"
+    end
+  end
+end

data/lib/cork/gem_version.rb

@@ -0,0 +1,3 @@
+module Cork
+  VERSION = '0.1.0'
+end

data/lib/cork/text_wrapper.rb

@@ -0,0 +1,76 @@
+# encoding: utf-8
+
+module Cork
+  module TextWrapper
+    # @return [String] Wraps a formatted string (e.g. markdown) by stripping
+    #          heredoc indentation and wrapping by word to the terminal width
+    #          taking into account a maximum one, and indenting the string.
+    #          Code lines (i.e. indented by four spaces) are not wrapped.
+    #
+    # @param   [String] string
+    #        The string to format.
+    #
+    # @param    [Fixnum] indent
+    #          The number of spaces to insert before the string.
+    #
+    # @param   [Fixnum] width
+    #         The width to use to format the string if the terminal
+    #         is too wide.
+    #
+    def wrap_formatted_text(string, indent = 0, width = 80)
+      paragraphs = strip_heredoc(string).split("\n\n")
+      paragraphs = paragraphs.map do |paragraph|
+        if paragraph.start_with?(' ' * 4)
+          paragraphs.gsub!(/\n/, "\n#{' ' * indent}")
+        else
+          paragraph = wrap_with_indent(paragraph, indent, width)
+        end
+        paragraph.insert(0, ' ' * indent).rstrip
+      end
+      paragraphs.join("\n\n")
+    end
+
+    module_function :wrap_formatted_text
+
+    # @return [String] Wraps a string to the terminal width taking into
+    #         account the given indentation.
+    #
+    # @param  [String] string
+    #         The string to indent.
+    #
+    # @param  [Fixnum] indent
+    #         The number of spaces to insert before the string.
+    #
+    # @param  [Fixnum] width
+    #         The width to use when formatting the string in the terminal
+    #
+    def wrap_with_indent(string, indent = 0, width = 80)
+      full_line = string.gsub("\n", ' ')
+      available_width = width - indent
+      space = ' ' * indent
+      word_wrap(full_line, available_width).split("\n").join("\n#{space}")
+    end
+
+    module_function :wrap_with_indent
+
+    # @return [String] Lifted straigth from Actionview. Thanks Guys!
+    #
+    def word_wrap(line, line_width)
+      line.gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1\n").strip
+    end
+
+    module_function :word_wrap
+
+    # @return [String] Lifted straigth from Actionview. Thanks Guys!
+    #
+    def strip_heredoc(string)
+      if min = string.scan(/^[ \t]*(?=\S)/).min
+        string.gsub(/^[ \t]{#{min.size}}/, '')
+      else
+        string
+      end
+    end
+
+    module_function :strip_heredoc
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: cork
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Karla Sandoval
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: bacon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: 
+email:
+- k.isabel.sandoval@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/cork.rb
+- lib/cork/board.rb
+- lib/cork/gem_version.rb
+- lib/cork/text_wrapper.rb
+homepage: https://github.com/CocoaPods/Cork
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 3
+summary: A delightful CLI UI module.
+test_files: []