lscolors 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c46cbe7b00077892a8e9717ded9c7854c71be270
-  data.tar.gz: 344fe45308c87f843867630b6a1104ad857ce5a1
+  metadata.gz: ce0d0a9417d7943c4914bb1e0ecf597255a46c74
+  data.tar.gz: 78a443cb981cb8a7a8a60f4bdb0c0b9890cee6f3
 SHA512:
-  metadata.gz: a9b85772b5b59074333808fded5d851b2cd76dace03cf421c3b59789788b8cbae2361ad1cdc9e00f773ebe0a6964855d7700000882e72cf4c9e8b876a1822f4e
-  data.tar.gz: 5ad0fb258238e5e79c3d5da023f8284340d1150e828d2d243afdac489b280e42f3b11f96945c1bb911352afc14a06ce9e1039b60dc4cdfbb6317b1c8e5c9e48d
+  metadata.gz: 5ffb89026c34dc585094d59b97ccf9a8e2901f0fb1388897b2cf57ee7c6d1f29b8f088e17cec83e635ef2e00dd480cb1ea7fdc6ca78003f9cc0b5120caf85092
+  data.tar.gz: 4ae82b94672758012e2806c3747c0a65c34ac54ee6f5a92a5d775931b90edf451db78fc0a941bd9093ea390496d9d56462d6809ef852a0c24f46bba03effd6f9

data/README.rdoc

@@ -3,11 +3,15 @@
 {<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]
 
+Source code:: https://github.com/Winterbraid/lscolors_ruby
+Gem:: https://rubygems.org/gems/lscolors
+Documentation:: http://www.rubydoc.info/gems/lscolors/frames
+
 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'`
+  export LS_COLORS=`ruby -rlscolors -e 'print LsColors::Colors'`
 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+
@@ -15,24 +19,27 @@ from the user's home directory. That file can also be created by running
 +LsColors.save+ without any parameters.
 
 ==Example use
+  require lscolors
+
+  include LsColors
 
   # Output the LS_COLORS configuration string
-  LsColors.to_s
+  Colors.to_s
 
   # Preview the current settings
-  puts LsColors.preview
+  puts Colors.preview
 
   # Save the settings to a file
-  LsColors.save 'test.json'
+  Colors.save 'test.json'
 
   # Display all available colors and their numbers
-  puts LsColors.test
+  puts Colors.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
+  puts LsColors::Colors.test
 
 If your terminal does not seem to support 256 colors, try adding the following
 line to your shell's +rc+ file:

data/lib/lscolors.rb

@@ -3,7 +3,7 @@ require 'json'
 # {include:file:README.rdoc}
 module LsColors
   # Current software version.
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 
   # Date of the current version.
   DATE = '2014-10-30'
@@ -11,142 +11,67 @@ module LsColors
   # 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
+  # Methods and data for manipulating terminal colors.
+  module ColorManipulation
+    # 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]
+      ]
+    }
 
     # Test the 16 system colors.
     #
@@ -161,9 +86,9 @@ module LsColors
     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)
-        )
+        cube_1 = (column..column + 5).to_a
+        cube_2 = (column + 36..column + 41).to_a
+        test_array(cube_1 + cube_2)
       end
 
       output.join
@@ -250,6 +175,88 @@ module LsColors
       string
     end
   end
+
+  # Load, modify, and output configuration.
+  module Colors
+    extend ColorManipulation
+
+    # The default configuration file. This will be loaded at startup if present.
+    RC_FILE = Dir.home << '/.lscolors_ruby.rc'
+
+    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
+    end
+  end
 end
 
-LsColors.load
+LsColors::Colors.load

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lscolors
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Winterbraid