pry-theme 0.0.3.pre → 0.0.4.pre

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Pry Theme changelog
 ===================
 
+### v0.0.4.pre (June 28, 2012)
+
+* Added `--all-colors` and `--color` options for `pry-theme` command;
+* Improved used experience when working with `pry-theme`.
+
 ### v0.0.3.pre (June 26, 2012)
 
 * Added support for Mac OS and Windows (I believe so, at least).

data/README.md

@@ -2,11 +2,6 @@
 
 * [https://github.com/kyrylo/pry-theme/][pt]
 
-Warning
-=======
-
-The project is in its infancy, so do expect bugs.
-
 Description
 -----------
 
@@ -19,21 +14,23 @@ Installation
 All you need is to install the gem. The `pry-theme` plugin will be detected and
 used automatically.
 
-    gem install pry-theme
+    gem install pry-theme --pre
 
 Synopsis
 --------
 
-### Configuration file
+### Theme files
 
-Pry Theme ships only with two themes: `pry-classic` and `pry-modern`. In order
-to set up the desired theme, add the following line to your `.pryrc`:
+Theme file is a valid YAML file, which has `.prytheme` extension (for example,
+`beautiful.prytheme`). Pry Theme ships only with two themes: `pry-classic` and
+`pry-modern`. In order to set up the desired theme, add the following line into
+your `.pryrc`:
 
     Pry.config.theme = "theme-name"
 
 The default theme is `pry-classic` (basically, you won't notice it, because
-it copies the default outlook of Pry, withouth the plugin). Let's change it to
-something more neoteric:
+it copies the default outlook of Pry, just as you didn't install anything).
+Let's change it to something more neoteric:
 
     Pry.config.theme = "pry-modern"
 
@@ -41,14 +38,13 @@ That's all! Launch your Pry and you will see the changes.
 
 ### CLI
 
-Pry Theme has a command-line interface via Pry. Currently, it can't do much. The
-only thing you can do is to switch themes on the fly. Start Pry and type the
-following:
+Pry Theme has a command-line interface available via Pry. Just launch Pry and
+start working with it. For example, you can _temporary_ change themes on the
+fly:
 
-    % pry --simple-prompt
-    >> pry-theme pry-classic
+    [1] pry(main)> pry-theme pry-classic
 
-We just temporary changed our current theme to `pry-classic`.
+This will switch your current theme to `pry-classic`.
 
 ### Creating themes
 
@@ -56,15 +52,43 @@ It's not easy now, so let's just skip this paragraph :P
 
 ### Adding new themes
 
-Theme files should have `.prytheme` extension. All theme files should be in
-`$XDG_CONFIG_HOME/pry-theme` directory. Don't forget to change your `.pryrc`!
+Theme files must have `.prytheme` extension.
+
+* On GNU/Linux
+
+    Put your theme file in `$XDG_CONFIG_HOME/pry-theme` directory. 
+
+* On Mac OS
+
+    Put your theme file in `$HOME/Library/Application Support/pry-theme` directory. 
+
+And don't forget to adjust your `.pryrc`!
 
 Limitations
 -----------
 
-* GNU/Linux (in future will support other popular platforms);
+Basically, it will run on any terminal that is capable of displaying 256 colors,
+but with a couple of admonishments.
+
+### OS support
+
+* GNU/Linux;
+* Mac OS (I hope so, leastwise);
+
+I don't plan to support Windows, because I can't even find a sane terminal for
+it. Sorry, Windows guys. If want me to change my mind, you have to file an
+issue.
+
+### Ruby versions
+
 * CRuby 1.9.3 (in future will support other implementations).
 
+Under the hood
+--------------
+
+Basically, Pry Theme is nothing but a CodeRay color scheme with a human-readable
+syntax.
+
 License
 -------
 

data/lib/pry-theme.rb

@@ -27,12 +27,20 @@ module PryTheme
   # Pry themes' directory.
   THEME_DIR = File.join(CONFIG_DIR, "pry-theme")
 
-  Setter = proc do |theme_name|
-    ::CodeRay::Encoders::Terminal::TOKEN_COLORS.merge!(PryTheme.convert(theme_name))
+  def self.set_theme(theme_name)
+    if theme = PryTheme.convert(theme_name)
+      ::CodeRay::Encoders::Terminal::TOKEN_COLORS.merge!(theme)
+    end
   end
 
   def self.convert(theme_name)
-    theme   = Theme.new(theme_name)
+    begin
+      theme = Theme.new(theme_name)
+    rescue NoThemeError => no_theme_error
+      warn no_theme_error
+      return
+    end
+
     palette = Palette.new(theme.color_depth)
     scheme  = {}
 
@@ -104,9 +112,7 @@ module PryTheme
                    Formatting::BACKGROUNDS[m[:bg]]
                  end
 
-    notation = "38;5" if palette.color_depth == 256
-
-    [notation, color_fg, formatting, color_bg].flatten.compact.join(";")
+    [palette.notation[0..-2], color_fg, formatting, color_bg].flatten.compact.join(";")
   end
 
 end

data/lib/pry-theme/commands.rb

@@ -2,16 +2,44 @@ module PryTheme
   Commands = Pry::CommandSet.new do
 
     create_command "pry-theme", "Manage your Pry themes." do
+
       banner <<-BANNER
         Usage: pry-theme [OPTIONS]
-          Change your theme on the fly.
-          e.g.: pry-theme pry-classic
+
+        Change your theme on the fly.
+        e.g.: pry-theme pry-modern
+        e.g.: pry-theme pry-classic
+        e.g.: pry-theme --all-colors 8
       BANNER
 
+      def options(opt)
+        opt.on :a, "all-colors", "Show all available 8/256 colors."
+        opt.on :c, "color",      "Show information about a specific color (256)."
+      end
+
       def process
-        unless args.empty?
-          PryTheme::Setter.call(args[0])
+        return if args.empty?
+
+        if opts.a?
+          output.puts Palette.new(args[0]).to_s
+        elsif opts.c?
+          unless args[0] =~ /\A(\d{1,3})\z/ && (0...256).include?($1.to_i)
+            raise NoColorError, "Invalid color number: #{ args[0] }"
+          end
+
+          pal = Palette.new(256)
+          color = pal.colors.detect { |c| c.term == args[0].to_i }
+
+          if color
+            output.puts color.to_term(pal.notation)
+          end
+        else
+          PryTheme.set_theme(args[0].strip) and output.puts "Using #{ args[0] } theme"
         end
+      rescue NoPaletteError => no_palette_error
+        warn no_palette_error
+      rescue NoColorError => no_color_error
+        warn no_color_error
       end
     end
 

data/lib/pry-theme/palette.rb

@@ -21,7 +21,11 @@ module PryTheme
   end
 
   # Creates a new color.
-  Color = Struct.new(:term, :human)
+  Color = Struct.new(:term, :human) do
+    def to_term(notation)
+      "\e[#{ notation }#{ term };7m#{ term }\e[0m:\e[#{ notation }#{ term }m#{ human }\e[0m"
+    end
+  end
 
   # Color palettes aka set of colors. Use 8 colors for limited terminals (like
   # `linux` or other pithecanthropic crap. Real men's choice is 256 colors).
@@ -33,13 +37,29 @@ module PryTheme
     # @return [Integer] The number representing max number of colors in theme.
     attr_reader :color_depth
 
+    # @return [String] The notation to be used in conversions to terminal.
+    attr_reader :notation
+
     # @param [Integer] colors The number of colors to be used in the palette.
     def initialize(colors=8)
-      palette = send("init_#{colors}_colors")
+      @color_depth = colors.to_i
+      @notation = "38;5;" if color_depth == 256
+
+      init_palette = "init_#{@color_depth}_colors"
+
+      if self.class.private_method_defined?(init_palette)
+        palette = send(init_palette)
+      else
+        raise NoPaletteError, "There is no palette with #{colors} colors (try 8 or 256)"
+      end
+
       @colors = palette[:term].zip(palette[:human]).map do |color|
         Color.new(*color)
       end
-      @color_depth = colors
+    end
+
+    def to_s
+      @colors.map { |c| c.to_term(@notation) }
     end
 
     private
@@ -59,4 +79,7 @@ module PryTheme
     end
 
   end
+
+  class NoPaletteError < StandardError; end
+  class NoColorError < StandardError; end
 end

data/lib/pry-theme/theme.rb

@@ -4,7 +4,14 @@ module PryTheme
     attr_reader :scheme, :author, :description, :color_depth, :version, :name
 
     def initialize(theme_filename)
-      theme = Psych.load_file(File.join(THEME_DIR, "#{theme_filename}.prytheme"))
+      theme_file = File.join(THEME_DIR, "#{theme_filename}.prytheme")
+
+      if File.exists?(theme_file)
+        theme = Psych.load_file(theme_file)
+      else
+        raise NoThemeError, "#{theme_filename}.prytheme doesn't exist"
+      end
+
       meta = theme["meta"]
 
       @name        = meta["theme-name"]
@@ -24,4 +31,6 @@ module PryTheme
     end
 
   end
+
+  class NoThemeError < StandardError; end
 end

data/lib/pry-theme/version.rb

@@ -1,3 +1,3 @@
 module PryTheme
-  VERSION = "0.0.3.pre"
+  VERSION = "0.0.4.pre"
 end

data/lib/pry-theme/when_started_hook.rb

@@ -8,12 +8,12 @@ module PryTheme
 
       (Dir.entries(EXAMPLES_ROOT) - %w{ . .. }).each do |f|
         unless File.exists?(File.join(THEME_DIR, f))
-          FileUtils.cp(File.join("examples", f), THEME_DIR)
+          FileUtils.cp(File.join(EXAMPLES_ROOT, f), THEME_DIR)
         end
       end
 
       theme_name = Pry.config.theme || "pry-classic"
-      PryTheme::Setter.call(theme_name)
+      PryTheme.set_theme(theme_name)
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pry-theme
 version: !ruby/object:Gem::Version
-  version: 0.0.3.pre
+  version: 0.0.4.pre
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-26 00:00:00.000000000 Z
+date: 2012-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry