lscolors 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 672e30fd44487f9322be34872a3c36943fcd32fd
+  data.tar.gz: b57d54a378ad63b864482ad0a88c5380e2deb660
+SHA512:
+  metadata.gz: ed3897bd901e5ed8d73f6bcea77fd447d1870c49181dc07691035d05f09b4fc0212b6c6a3e6bea896d5f76a13af8d1ae967bf820e152bc81ab8703c336ce2da7
+  data.tar.gz: 9d047750e84c7c01b09387d43bbcd4d31906d76d81408ad96dab31e9b9dac0a5f6cc9a74f915fe7c0d5b1cec9c0707811eb6ac0b9b3d378a1fcd3eed94b0da69

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Winterbraid
+
+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.rdoc

@@ -0,0 +1,45 @@
+=LsColors
+
+{<img src="http://inch-ci.org/github/Winterbraid/lscolors_ruby.svg?branch=master" alt="Inline docs" />}[http://inch-ci.org/github/Winterbraid/lscolors_ruby]
+{<img src="https://codeclimate.com/github/Winterbraid/lscolors_ruby/badges/gpa.svg" />}[https://codeclimate.com/github/Winterbraid/lscolors_ruby]
+
+Allows loading color definitions from JSON, previewing, and printing a
++LS_COLORS+ compatible config string.
+
+To use the configuration, do the following in your terminal:
+  export LS_COLORS=`ruby -rlscolors -e 'print LsColors'`
+You will probably want to add the above line to your shell's +rc+ file.
+
+By default, LsColors will try to load a file called +.lscolors_ruby.rc+
+from the user's home directory. That file can also be created by running
++LsColors.save+ without any parameters.
+
+==Example use
+
+  # Output the LS_COLORS configuration string
+  LsColors.to_s
+
+  # Preview the current settings
+  puts LsColors.preview
+
+  # Save the settings to a file
+  LsColors.save 'test.json'
+
+  # Display all available colors and their numbers
+  puts LsColors.test
+
+==Troubleshooting
+
+LsColors assumes a 256-color compatible terminal. Use the following code
+to test your terminal's capability (this can also help you get color numbers):
+  puts LsColors.test
+
+If your terminal does not seem to support 256 colors, try adding the following
+line to your shell's +rc+ file:
+  export TERM=xterm-256color
+
+If you are looking for a good graphic terminal emulator, try
+{Terminator}[http://gnometerminator.blogspot.com/p/introduction.html].
+If the colors do not seem to display correctly in +screen+, refer to
+{this guide}[http://robotsrule.us/vim/] or try
+{Tmux}[http://tmux.sourceforge.net/], which can do all +screen+ can and more.

data/lib/lscolors.rb

@@ -0,0 +1,255 @@
+require 'json'
+
+# {include:file:README.rdoc}
+module LsColors
+  # Current software version.
+  VERSION = '1.0.0'
+
+  # Date of the current version.
+  DATE = '2014-10-30'
+
+  # A short description.
+  ABOUT = 'Manipulate LS_COLORS settings.'
+
+  # The default configuration file. This will be loaded at startup if present.
+  RC_FILE = Dir.home << '/.lscolors_ruby.rc'
+
+  # The string that begins a terminal-compatible color definition.
+  COLOR_HEAD = "\x1b["
+
+  # The prefix for the foreground color (256 colors).
+  COLOR_FG = '38;5;'
+
+  # The prefix for the background color (256 colors).
+  COLOR_BG = '48;5;'
+
+  # The string that ends a terminal-compatible color definition.
+  COLOR_TAIL = 'm'
+
+  # This string resets color and style to default.
+  COLOR_RESET = "\x1b[0m"
+
+  # The style codes recognized by the terminal.
+  STYLES = {
+    bold: '01',
+    under: '04',
+    blink: '05',
+    reverse: '07',
+    conceal: '08'
+  }
+
+  # Explanation of system-related file codes, for previewing and learning
+  # purposes.
+  CODE_DESCRIPTIONS = {
+    di: 'directory',
+    fi: 'file',
+    ln: 'symlink',
+    pi: 'fifo',
+    so: 'socket',
+    bd: 'block',
+    or: 'orphan',
+    mi: 'missing',
+    ex: 'executable'
+  }
+
+  # The fallback color sheet.
+  DEFAULTS = {
+    system: [
+      ['di', 33, :bold], ['ln', 45], ['mh', 15, 5],
+      ['pi', 11, 1], ['so', 13], ['do', 5], ['bd', 11, 232], ['cd', 3, 232],
+      ['or', 45, 9], ['mi', 15, 232, :blink], ['su', 15, 196],
+      ['sg', 16, 11], ['ca', 226, 196], ['tw', 16, 10], ['ow', 21, 10],
+      ['st', 15, 21], ['ex', 35, :bold]
+    ],
+    extensions: [
+      ['sh pl py swf bat exe', 35],
+      ['rb rbw rdoc gemspec gem', 197],
+      ['png jpg jpeg gif bmp tiff xcf', 111],
+      ['mp4 mkv avi ogm mov mpeg flv wmv', 171],
+      ['mp3 mp2 ogg flac wav wma ape mid midi', 168],
+      ['gb gba nds 3ds bin iso dat grp pak', 202],
+      ['rar zip tar gz tgz 7z bz2', 215],
+      ['txt odt doc docx pdf djvu', 247],
+      ['bak old log', 241]
+    ]
+  }
+
+  class << self
+    # Loads or initializes settings. The parameter can be either a Hash or a
+    # String (in the latter case it will be interpreted as the file name of
+    # a JSON file). If missing, the method will look for a JSON file specified
+    # by {RC_FILE}, and if absent, the {DEFAULTS} will be loaded.
+    #
+    # @param [String, Hash] object
+    # @return [Hash] the parsed settings.
+    def load(object = nil)
+      return @colors = object if object.is_a? Hash
+
+      if object.is_a? String
+        return @colors = JSON.parse(File.read(object), symbolize_names: true)
+      elsif File.exist? RC_FILE
+        return @colors = JSON.parse(File.read(RC_FILE), symbolize_names: true)
+      end
+
+      @colors = DEFAULTS
+    end
+
+    # Will preview the current settings as a string of colorized system files
+    # and extensions. Use +print+ or +puts+ to see the effect (a 256-color
+    # terminal is required).
+    #
+    # @return [String]
+    def preview
+      "#{preview_system}\n#{preview_extensions}"
+    end
+
+    # Save the current settings to a file. Without parameters, {RC_FILE} will be
+    # created and/or saved. {RC_FILE} will be loaded automatically from now on,
+    # so it can be modified directly in order to configure the color settings.
+    #
+    # @param [String] file the file name to save to.
+    # @return [0]
+    def save(file = RC_FILE)
+      File.write(file, JSON.pretty_generate(@colors))
+      0
+    end
+
+    # Test the terminal color capability.
+    #
+    # @return [String]
+    def test
+      colors = `tput colors`.to_i
+      fail "256 colors not supported! (#{colors})" if colors < 256
+
+      "System colors (0-15):\n#{test_system}\n" \
+        "Color cube (16-231):\n#{test_cube}\n" \
+        "Grayscale colors (232-255):\n#{test_grayscale}\n"
+    end
+
+    # Will output the +LS_COLORS+ compatible configuration string.
+    #
+    # @return [String]
+    def to_s
+      output = 'rs=0:'
+
+      @colors[:system].each do |c|
+        output << "#{c.first}=#{color_setting(c)}:"
+      end
+
+      @colors[:extensions].each do |c|
+        c.first.split.sort.each do |ext|
+          output << "*.#{ext}=#{color_setting(c)}:"
+        end
+      end
+
+      output
+    end
+    alias_method :inspect, :to_s
+
+    private
+
+    # Test the 16 system colors.
+    #
+    # @return [String]
+    def test_system
+      [(0..7), (8..15)].map { |range| test_array range.to_a }.join
+    end
+
+    # Test the 6x6x6 color cube.
+    #
+    # @return [String]
+    def test_cube
+      output = (0..17).map do |row|
+        column = 16 + (row * 6) + (36 * (row / 6))
+        test_array(
+          ((column..column + 5).to_a + (column + 36..column + 41).to_a)
+        )
+      end
+
+      output.join
+    end
+
+    # Test the 24 grayscale colors.
+    #
+    # @return [String]
+    def test_grayscale
+      [(232..243), (244..255)].map { |range| test_array range.to_a }.join
+    end
+
+    # Test an array of color numbers.
+    #
+    # @param [Array] array the color numbers to test.
+    # @return [String]
+    def test_array(array)
+      output = array.map { |color| color_card(color) } << "\n"
+
+      output.join
+    end
+
+    # Returns a preview of a single color.
+    #
+    # @param [Integer] color
+    # @return [String]
+    def color_card(color)
+      "#{colorizer ['foo', 0, color]}   #{format '%03d', color}#{COLOR_RESET}"
+    end
+
+    # Take an array as per the {DEFAULTS} format and create a terminal style
+    # escape string.
+    #
+    # @param [Array] array
+    # @return [String]
+    def colorizer(array)
+      fail "No foreground color in #{array}." unless array[1].is_a? Integer
+      "#{COLOR_HEAD}#{color_setting(array)}#{COLOR_TAIL}"
+    end
+
+    # Take an array as per the {DEFAULTS} format and create a color definition
+    # string.
+    #
+    # @param [Array] array
+    # @return [String]
+    def color_setting(array)
+      string = ''
+
+      STYLES.each_pair do |style, code|
+        next unless array.include?(style) || array.include?(style.to_s)
+        string << "#{code};"
+      end
+      string << "#{COLOR_FG}#{array[1]}"
+      string << ";#{COLOR_BG}#{array[2]}" if array[2].is_a? Integer
+
+      string
+    end
+
+    # Return a colorized preview of the system file color settings.
+    #
+    # @return [String]
+    def preview_system
+      array = @colors[:system].map do |c|
+        code = CODE_DESCRIPTIONS.fetch(c.first.to_sym, c.first)
+        "#{colorizer(c)}#{code}#{COLOR_RESET}"
+      end
+
+      array.join ' '
+    end
+
+    # Return a colorized preview of the extension color settings.
+    #
+    # @return [String]
+    def preview_extensions
+      string = ''
+
+      @colors[:extensions].each do |c|
+        c.first.split.sort.each do |ext|
+          string << "#{colorizer(c)}*.#{ext}#{COLOR_RESET} "
+        end
+        string << "\n"
+      end
+
+      string
+    end
+  end
+end
+
+LsColors.load

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: lscolors
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Winterbraid
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      Parses hashes or JSON files and generates LS_COLORS compatible config
+      strings.
+email: Winterbraid@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.rdoc
+- lib/lscolors.rb
+homepage: https://github.com/Winterbraid/lscolors_ruby
+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: Manipulate LS_COLORS settings.
+test_files: []
+has_rdoc: