wasko 0.0.1

data/lib/wasko.rb

@@ -0,0 +1,111 @@
+require "color/palette/monocontrast"
+require "yaml"
+# [Applescript: Small wrapper for running applescript](applescript.html)
+require "wasko/applescript"
+# [Terminal: Support for Terminal.app](terminal.html)
+require "wasko/terminal"
+# [Color: Small color utilities](color.html)
+require "wasko/color"
+# [Palette: Generates a color scheme](palette.html)
+require "wasko/palette"
+# [Configuration: Loading and saving themes](configuration.html)
+require "wasko/configuration"
+
+module Wasko
+  class << self
+
+    # Currently this only returns Apple's `Terminal.app`,
+    # in the future this could be used to support other
+    # Terminals as well.
+    def advanced_typing_apparatus
+      Wasko::Terminal
+    end
+
+    # ## Set/Get fonts and colors
+    #
+    # These all call the `advanced_typing_apparatus` and
+    # do exactly what they say on the tin.
+    #
+    def background_color
+      ::Color::RGB.from_applescript(advanced_typing_apparatus.background_color).html
+    end
+
+    def set_background_color(color)
+      advanced_typing_apparatus.set_background_color(Wasko::Color.color_from_string(color).to_applescript)
+    end
+
+    def foreground_color
+      ::Color::RGB.from_applescript(advanced_typing_apparatus.normal_text_color).html
+    end
+
+    def set_foreground_color(color)
+      advanced_typing_apparatus.set_normal_text_color(Wasko::Color.color_from_string(color).to_applescript)
+    end
+
+    def bold_color
+      ::Color::RGB.from_applescript(advanced_typing_apparatus.bold_text_color).html
+    end
+
+    def set_bold_color(color)
+      advanced_typing_apparatus.set_bold_text_color(Wasko::Color.color_from_string(color).to_applescript)
+    end
+
+    def cursor_color
+      ::Color::RGB.from_applescript(advanced_typing_apparatus.cursor_color).html
+    end
+
+    def set_cursor_color(color)
+      advanced_typing_apparatus.set_cursor_color(Wasko::Color.color_from_string(color).to_applescript)
+    end
+
+    def font_name
+      advanced_typing_apparatus.font_name
+    end
+
+    def set_font_name(name)
+      advanced_typing_apparatus.set_font_name name
+    end
+
+    def font_size
+      advanced_typing_apparatus.font_size
+    end
+
+    def set_font_size(size)
+       advanced_typing_apparatus.set_font_size size
+    end
+
+    def font
+      "#{advanced_typing_apparatus.font_name}, #{advanced_typing_apparatus.font_size}"
+    end
+
+    def set_font(font_size = 14, name = nil)
+      name = font_name if name.empty?
+      set_font_size font_size
+      set_font_name name
+    end
+
+    # ## Palette
+    #
+    # Returns a string representation of the current settings
+    def palette
+      [
+       "Background: #{background_color}",
+       "Foreground: #{foreground_color}",
+       "Bold Text : #{bold_color}",
+       "Cursor    : #{cursor_color}",
+       "Font      : #{font}"
+      ].join("\n")
+    end
+
+    # Try to set a sensible palette from a base color
+    def set_palette(color_string)
+      p = Wasko::Palette::TheOriginal.new(color_string)
+
+      set_background_color p.colors[:base].html
+      set_foreground_color p.colors[:foreground].html
+      set_bold_color p.colors[:bold].html
+      set_cursor_color p.colors[:cursor].html
+    end
+
+  end
+end

data/lib/wasko/applescript.rb

@@ -0,0 +1,17 @@
+module Wasko
+  class Applescript
+    # Runs a piece of Applescript,
+    #
+    #      Wasko::Applescript.run do
+    #        "set ten_and_ten to 10 + 10"
+    #      end
+    #      => "20"
+    #
+    # Since Applescript has a nasy bit of littering its
+    # return values with `\n`, already escaping those.
+    def self.run
+        value = `/usr/bin/osascript -e "#{yield.gsub('"', '\"')}"`
+        value.gsub("\n", '')
+      end
+  end
+end

data/lib/wasko/color.rb

@@ -0,0 +1,213 @@
+require "color"
+
+class Color::RGB
+
+  class << self
+    # Creates a `color` from an `Applescript` string,
+    # `Applescript` uses `short int` to make the RGB,
+    # `65535` is the maximum.
+    #
+    # Example:
+    #
+    #      Color::RGB.from_applescript "65535,65535,65535"
+    #        => <RGB [#ffffff]>
+    #
+    def from_applescript(applescript_string)
+      applescript_string.gsub!(/\{|\}/, "")
+      rgb = applescript_string.strip.split(",")
+      colors = rgb.map do |value|
+        value.to_i / 257
+      end
+      Color::RGB.new(*colors)
+    end
+  end
+
+  # Converts an instance of `Color` to an `Applescript`
+  # string color format.
+  def to_applescript
+    rgb = [self.red.to_i * 257, self.green.to_i * 257, self.blue.to_i * 257].join(", ")
+    "{#{rgb}}"
+  end
+end
+
+module Wasko
+  # This class will be used to handle (aptly named, it is)
+  # all things concerning Color. Internally we'll be mostly
+  # using the [color gem](http://rubydoc.info/gems/color/1.4.1/frames)
+  class Color
+
+    # Tries to get a `Color` from a string, will return `false`
+    # if it fails to do so, if it does recognize a color converts it
+    # to a format that `Applescript` will support.
+    #
+    # At the moment support all named css-colors (like `red`, `aliceblue`, etc.)
+    # and all hex-colors.
+    def self.color_from_string(color_string)
+      return ::Color::RGB.from_html(color_string)             if hex_color?(color_string)
+      return ::Color::RGB.from_html(names_hash[color_string]) if named_color?(color_string)
+      false
+    end
+
+    # Looks through all the named css colors
+    def self.named_color?(color_string)
+      names_hash.keys.include?(color_string)
+    end
+
+    def self.hex_color?(color_string)
+      # Blatantly stolen from [here](http://www.geekzilla.co.uk/View05C802F8-F1DF-4097-A969-0EACB51C7834.htm)
+      color_string =~ /^#?([a-f]|[A-F]|[0-9]){3}(([a-f]|[A-F]|[0-9]){3})?$/
+    end
+
+    def self.names_hash
+      {
+        "aliceblue" => "#f0f8ff",
+        "antiquewhite" => "#faebd7",
+        "aqua" => "#00ffff",
+        "aquamarine" => "#7fffd4",
+        "azure" => "#f0ffff",
+        "beige" => "#f5f5dc",
+        "bisque" => "#ffe4c4",
+        "black" => "#000000",
+        "blanchedalmond" => "#ffebcd",
+        "blue" => "#0000ff",
+        "blueviolet" => "#8a2be2",
+        "brown" => "#a52a2a",
+        "burlywood" => "#deb887",
+        "cadetblue" => "#5f9ea0",
+        "chartreuse" => "#7fff00",
+        "chocolate" => "#d2691e",
+        "coral" => "#ff7f50",
+        "cornflowerblue" => "#6495ed",
+        "cornsilk" => "#fff8dc",
+        "crimson" => "#dc143c",
+        "cyan" => "#00ffff",
+        "darkblue" => "#00008b",
+        "darkcyan" => "#008b8b",
+        "darkgoldenrod" => "#b8860b",
+        "darkgray" => "#a9a9a9",
+        "darkgrey" => "#a9a9a9",
+        "darkgreen" => "#006400",
+        "darkkhaki" => "#bdb76b",
+        "darkmagenta" => "#8b008b",
+        "darkolivegreen" => "#556b2f",
+        "darkorange" => "#ff8c00",
+        "darkorchid" => "#9932cc",
+        "darkred" => "#8b0000",
+        "darksalmon" => "#e9967a",
+        "darkseagreen" => "#8fbc8f",
+        "darkslateblue" => "#483d8b",
+        "darkslategray" => "#2f4f4f",
+        "darkslategrey" => "#2f4f4f",
+        "darkturquoise" => "#00ced1",
+        "darkviolet" => "#9400d3",
+        "deeppink" => "#ff1493",
+        "deepskyblue" => "#00bfff",
+        "dimgray" => "#696969",
+        "dimgrey" => "#696969",
+        "dodgerblue" => "#1e90ff",
+        "firebrick" => "#b22222",
+        "floralwhite" => "#fffaf0",
+        "forestgreen" => "#228b22",
+        "fuchsia" => "#ff00ff",
+        "gainsboro" => "#dcdcdc",
+        "ghostwhite" => "#f8f8ff",
+        "gold" => "#ffd700",
+        "goldenrod" => "#daa520",
+        "gray" => "#808080",
+        "grey" => "#808080",
+        "green" => "#008000",
+        "greenyellow" => "#adff2f",
+        "honeydew" => "#f0fff0",
+        "hotpink" => "#ff69b4",
+        "indianred" => "#cd5c5c",
+        "indigo" => "#4b0082",
+        "ivory" => "#fffff0",
+        "khaki" => "#f0e68c",
+        "lavender" => "#e6e6fa",
+        "lavenderblush" => "#fff0f5",
+        "lawngreen" => "#7cfc00",
+        "lemonchiffon" => "#fffacd",
+        "lightblue" => "#add8e6",
+        "lightcoral" => "#f08080",
+        "lightcyan" => "#e0ffff",
+        "lightgoldenrodyellow" => "#fafad2",
+        "lightgray" => "#d3d3d3",
+        "lightgrey" => "#d3d3d3",
+        "lightgreen" => "#90ee90",
+        "lightpink" => "#ffb6c1",
+        "lightsalmon" => "#ffa07a",
+        "lightseagreen" => "#20b2aa",
+        "lightskyblue" => "#87cefa",
+        "lightslategray" => "#778899",
+        "lightslategrey" => "#778899",
+        "lightsteelblue" => "#b0c4de",
+        "lightyellow" => "#ffffe0",
+        "lime" => "#00ff00",
+        "limegreen" => "#32cd32",
+        "linen" => "#faf0e6",
+        "magenta" => "#ff00ff",
+        "maroon" => "#800000",
+        "mediumaquamarine" => "#66cdaa",
+        "mediumblue" => "#0000cd",
+        "mediumorchid" => "#ba55d3",
+        "mediumpurple" => "#9370d8",
+        "mediumseagreen" => "#3cb371",
+        "mediumslateblue" => "#7b68ee",
+        "mediumspringgreen" => "#00fa9a",
+        "mediumturquoise" => "#48d1cc",
+        "mediumvioletred" => "#c71585",
+        "midnightblue" => "#191970",
+        "mintcream" => "#f5fffa",
+        "mistyrose" => "#ffe4e1",
+        "moccasin" => "#ffe4b5",
+        "navajowhite" => "#ffdead",
+        "navy" => "#000080",
+        "oldlace" => "#fdf5e6",
+        "olive" => "#808000",
+        "olivedrab" => "#6b8e23",
+        "orange" => "#ffa500",
+        "orangered" => "#ff4500",
+        "orchid" => "#da70d6",
+        "palegoldenrod" => "#eee8aa",
+        "palegreen" => "#98fb98",
+        "paleturquoise" => "#afeeee",
+        "palevioletred" => "#d87093",
+        "papayawhip" => "#ffefd5",
+        "peachpuff" => "#ffdab9",
+        "peru" => "#cd853f",
+        "pink" => "#ffc0cb",
+        "plum" => "#dda0dd",
+        "powderblue" => "#b0e0e6",
+        "purple" => "#800080",
+        "red" => "#ff0000",
+        "rosybrown" => "#bc8f8f",
+        "royalblue" => "#4169e1",
+        "saddlebrown" => "#8b4513",
+        "salmon" => "#fa8072",
+        "sandybrown" => "#f4a460",
+        "seagreen" => "#2e8b57",
+        "seashell" => "#fff5ee",
+        "sienna" => "#a0522d",
+        "silver" => "#c0c0c0",
+        "skyblue" => "#87ceeb",
+        "slateblue" => "#6a5acd",
+        "slategray" => "#708090",
+        "slategrey" => "#708090",
+        "snow" => "#fffafa",
+        "springgreen" => "#00ff7f",
+        "steelblue" => "#4682b4",
+        "tan" => "#d2b48c",
+        "teal" => "#008080",
+        "thistle" => "#d8bfd8",
+        "tomato" => "#ff6347",
+        "turquoise" => "#40e0d0",
+        "violet" => "#ee82ee",
+        "wheat" => "#f5deb3",
+        "white" => "#ffffff",
+        "whitesmoke" => "#f5f5f5",
+        "yellow" => "#ffff00",
+        "yellowgreen" => "#9acd32"
+      }
+    end
+  end
+end

data/lib/wasko/configuration.rb

@@ -0,0 +1,87 @@
+require "fileutils"
+
+module Wasko
+  # This class will handle all things considering
+  # loading and saving configuration. It should work
+  # like this.
+  #
+  #  * User sets all things to his liking
+  #  * User writes to a `.color` file in `~/.wasko`
+  #  * User can share/edit this `.color` file
+  #  * User can load `.color` file to restore settings
+  #
+  class Configuration
+    class << self
+
+      # All config files are stored in `~/.wasko/`
+      def wasko_directory
+        wasko_path = File.join(ENV['HOME'], ".wasko")
+        unless File.exists?(wasko_path) && File.directory?(wasko_path)
+          FileUtils.mkdir_p File.join(ENV['HOME'], ".wasko")
+        end
+        wasko_path
+      end
+
+      # All possible `.color` themes
+      def all_themes
+        Dir.chdir(wasko_directory) do |path|
+          Dir["*.color"].map do |filename|
+            filename.gsub(/\.color$/, "")
+          end
+        end
+      end
+
+      # Blatantly stolen from [here](http://stackoverflow.com/questions/1032104/regex-for-finding-valid-filename)
+      # Spots all obvious bad filenames
+      def valid_name?(name)
+        name =~ /^[^\/?*:;{}\\]+$/
+      end
+
+      # File path of the color theme file
+      def config_file_with_name(name)
+        File.join(wasko_directory, "#{name}.color")
+      end
+
+      # Setup the color theme with the hash.
+      def color_theme_from_hash(name)
+        return {} unless all_themes.include?(name)
+        return {} unless Hash === YAML::load(File.open(config_file_with_name(name)))
+        YAML::load(File.open(config_file_with_name(name)))
+      end
+
+      # Transform a color theme to a hash
+      def color_theme_to_hash
+        %w(background_color foreground_color bold_color cursor_color font_size font_name).inject({}) do |hash, value|
+          hash[value] = Wasko.send(value)
+          hash
+        end
+      end
+
+      # ## Loading and saving colors
+
+      # Draw the saved colors
+      def load_colors!(name)
+        color_theme_from_hash(name).each do |object, color|
+          Wasko.send("set_#{object}", color)
+        end
+      end
+
+      # Write out the colors
+      def save_colors!(name)
+        File.open(config_file_with_name(name), 'w') do |out|
+          out.write(configuration_help)
+          out.write(color_theme_to_hash.to_yaml)
+        end
+      end
+
+      def configuration_help
+        <<HELP
+# This is a theme used by the wasko gem, it's nothing
+# more than regular yaml. So (ab)use as you would normally
+# do. The only thing to note is, colors take only valid
+# css colors and this comment can be deleted.
+HELP
+      end
+    end
+  end
+end

data/lib/wasko/palette.rb

@@ -0,0 +1,90 @@
+module Wasko
+  # A module aimed at creating color schemes for terminals
+  # Pretty straightforward, no?
+  module Palette
+    # Since I change my mind pretty frequently on
+    # color schemes etc. Putting the actual logic in
+    # a class so it's easier to extend.
+    class TheOriginal
+      # Takes a valid css color string and an optional
+      # contrast argument. The contrast is useful to tweak
+      # the output of things.
+      #
+      # It sets a base color `@base` and creates a color
+      # palette derived from the base color using the
+      # `colors!` method.
+      def initialize(color_string, contrast = 0)
+        @colors = {}
+        @base = Wasko::Color.color_from_string(color_string)
+        @base = white unless @base
+        @contrast = 30 + contrast
+        colors!
+      end
+
+      # Returns a `color`-instance of white
+      def white
+        Wasko::Color.color_from_string("white")
+      end
+
+      # Returns a `color`-instance of black
+      def black
+        Wasko::Color.color_from_string("black")
+      end
+
+      # Checks the brightness of the base color and
+      # returns the appropriate opposite color.
+      #
+      # For example black will return white, white will
+      # return black.
+      def opposite_color
+        @base.brightness > 0.5 ? black : white
+      end
+
+      # To calculate colors that will fit our base color
+      # we need to find out to brighten them, or darken
+      # them
+      def inverse_brightness
+        @base.brightness > 0.5 ? -1 : 1
+      end
+
+      # Hash of the color palette
+      # TODO: attr_accessible
+      def colors
+        @colors
+      end
+
+      # Creates a palette based on the `@base`-color. This
+      # generates a color palette which has taken a good
+      # look at [Solarized](http://ethanschoonover.com/solarized)
+      # The plus side is you can use any base color, the
+      # downside is, the colors won't be picked as well as
+      # when using [Solarized](http://ethanschoonover.com/solarized) so if that's what you need, check it out.
+      def colors!
+        p = {}
+        p[:base]       = @base
+        p[:foreground] = @base.mix_with(opposite_color, @contrast + 18)
+        p[:bold]       = @base.mix_with(opposite_color, @contrast + 19.5)
+        p[:selection]  = @base.adjust_brightness inverse_brightness * @contrast
+        p[:selected]   = p[:bold]
+        p[:cursor]     = p[:foreground]
+
+        # ANSI Colors
+        p[:red]     = mix_base_with("red", 50, inverse_brightness * @contrast)
+        p[:green]   = mix_base_with("green", 50, inverse_brightness * @contrast)
+        p[:yellow]  = mix_base_with("yellow", 50, inverse_brightness * @contrast)
+        p[:white]   = mix_base_with("white", 35, inverse_brightness * @contrast)
+        p[:black]   = mix_base_with("black", 35, inverse_brightness * @contrast)
+        p[:blue]    = mix_base_with("blue", 50, inverse_brightness * (@contrast))
+        p[:magenta] = mix_base_with("#CA1F7B", 35, inverse_brightness * @contrast)
+        p[:cyan]    = mix_base_with("#00FFFF", 50, inverse_brightness * (@contrast - 20))
+        @colors = p
+      end
+
+      # Just a utility method that mixes colors, for more
+      # info on this check the docs of the `color`-gem.
+      def mix_base_with(color_name, mix_value = 50, brightness = 30)
+        @base.mix_with(Wasko::Color.color_from_string(color_name), mix_value).adjust_brightness(brightness)
+      end
+    end
+  end
+end