pry-theme 0.1.3 → 0.2.0

data/lib/pry-theme/term.rb

@@ -0,0 +1,66 @@
+module PryTheme
+  # @since 0.2.0
+  # @api private
+  #
+  # Represents a terminal colour (not ANSI). Checks whether a number fits in its
+  # colour model.
+  class TERM
+
+    # @return [Integer] the values are 8, 16 or 256
+    attr_reader :color_model
+
+    # @param [Integer] value
+    # @param [Integer] color_model
+    def initialize(value, color_model = 256)
+      validate_attrs(value, color_model)
+      @value = value
+      @color_model = color_model
+    end
+
+    # @return [String]
+    def inspect
+      "(TERM-#{ @color_model }: #{ @value })"
+    end
+
+    # @return [Integer]
+    def to_i
+      @value
+    end
+
+    private
+
+    # @param [Integer] value
+    # @param [Integer] color_model
+    # @raise [ArgumentError] if the +value+ isn't a valid Integer (not in
+    #   +color_model+ range) or provided incorrect +color_model+
+    # @raise [TypeError] if the +value+ or the +color_model+ isn't an Integer
+    #   at all
+    # @return [void]
+    def validate_attrs(value, color_model)
+      fixnums = value.is_a?(Fixnum) && color_model.is_a?(Fixnum)
+      correct_term =
+        if fixnums
+          case color_model
+          when 256 then value.between?(0, 255)
+          when 16  then value.between?(0, 15)
+          when 8   then value.between?(0, 7)
+          else raise ArgumentError,
+                    'invalid color model for PryTheme::TERM#new(): ' \
+                    "\"#{ color_model }\""
+          end
+        end
+
+      return true if fixnums && correct_term
+
+      unless fixnums
+        raise TypeError, "can't convert #{ value.class } into PryTheme::TERM"
+      end
+
+      unless correct_term
+        raise ArgumentError,
+          %|invalid TERM number for PryTheme::TERM#new(): "#{ value }"|
+      end
+    end
+
+  end
+end

data/lib/pry-theme/theme.rb

@@ -1,44 +1,134 @@
 module PryTheme
+
+  # Raised when something goes wrong with Pry Theme themes. It's a general
+  # exception for everything that comes into collision in theme files.
+  ThemeError = Class.new(StandardError)
+
+  # @since 0.2.0
+  # @api private
+  # @see PryTheme::create
+  #
+  # Creates a new Pry Theme theme. This class is not meant for the direct
+  # instantiation. Use {PryTheme::create} instead.
   class Theme
 
-    attr_reader :scheme, :author, :description, :color_depth, :version, :name
+    DEFAULT_CONFIG = {
+      :name           => "prytheme-#{ rand(1_000_000_000) }",
+      :color_model    => 256,
+      :author         => 'Unknown Author',
+      :description    => '',
+    }
 
-    def initialize(theme_filename)
-      theme_file = Helper.pathify_theme(theme_filename)
+    # Matches against valid theme name. It must start with a letter. The letter
+    # case is not important.
+    VALID_NAME = /\A[A-z][A-z0-9-]*\z/i
 
-      if File.exists?(theme_file)
-        theme = YAML.load_file(theme_file)
-      else
-        raise NoThemeError, "#{theme_filename}.prytheme doesn't exist"
-      end
+    # @return [Theme::Definition] the heart of every theme: the colour
+    #   definitions
+    attr_reader :definition
+
+    # @return [Boolean] whether this theme is a current theme
+    attr_reader :active
+    alias_method :active?, :active
+
+    # @see PryTheme::create
+    def initialize(config = {}, &block)
+      @config = DEFAULT_CONFIG.merge(config)
+      @authors = [{ :name => @config[:author] }]
+      @default_author = true
+      @active = false
+
+      validate_config
+
+      instance_eval(&block)
+    end
 
-      meta = theme["meta"]
+    def author(options = nil)
+      if options
+        if options[:name].length > 32
+          raise PryTheme::ThemeError,
+            "author's name must be no longer than 32 characters"
+        end
 
-      @name        = meta["theme-name"]
-      @version     = meta["version"]
-      @color_depth = meta["color-depth"].to_i
+        if @default_author
+          @default_author = false
+          @authors[0] = options
+        else
+          @authors << options
+        end
+      end
+      @authors
+    end
 
-      # Forbid too long descriptions.
-      if @description = meta["description"]
-        if (size = @description.size) > 80
-          raise ThemeDescriptionError, "Description of #{name} theme is too long (#{size}). Max size is 80 characters."
+    def description(text = nil)
+      if text
+        if text.length > 280
+          raise PryTheme::ThemeError,
+            "description must be no longer than 280 characters"
         end
+        @config[:description] = text
       end
+      @config[:description]
+    end
+
+    def define_theme(&block)
+      @definition = Definition.new(color_model, &block)
+    end
 
-      @author      = meta["author"]
-      @scheme      = theme["theme"]
+    def name
+      @config[:name]
     end
 
-    def method_missing(method_name, *args, &block)
-      if @scheme.has_key?(method_name.to_s)
-        @scheme[method_name.to_s]
-      else
-        super
+    def color_model
+      @config[:color_model]
+    end
+
+    def disable
+      @active = false
+    end
+
+    def activate
+      ::CodeRay::Encoders::Terminal::TOKEN_COLORS.merge!(to_coderay)
+      @active = true
+    end
+
+    def to_coderay
+      {}.tap do |coderay|
+        @definition.class.instance_methods(false).each { |attr|
+          attr = attr.to_sym
+          val = @definition.__send__(attr) if @definition
+
+          unless val.kind_of?(Color)
+            coderay[attr] = {}
+            ivars = val.instance_variables.delete_if { |v| v =~ /color_model/}
+            ivars.each do |ivar|
+              coderay[attr][ivar.to_s.chomp('_')[1..-1].to_sym] =
+                val.instance_variable_get(ivar).to_ansi
+            end
+          else
+            coderay[attr.to_s.chomp('_').to_sym] = val.to_ansi
+          end
+        }
       end
     end
 
-  end
+    private
 
-  class NoThemeError < StandardError; end
-  class ThemeDescriptionError < StandardError; end
+    def validate_config
+      if name !~ VALID_NAME
+        raise PryTheme::ThemeError, 'theme name must start with a letter'
+      end
+
+      if name.length > 18
+        raise PryTheme::ThemeError,
+          'theme name must be no longer than 18 characters'
+      end
+
+      unless [256, 8, 16].include?(color_model)
+        raise PryTheme::ThemeError,
+          'incorrect color model. Available values: 8, 16 or 256'
+      end
+    end
+
+  end
 end

data/lib/pry-theme/theme_list.rb

@@ -0,0 +1,52 @@
+module PryTheme
+  module ThemeList
+
+    extend self
+
+    def themes
+      @themes ||= []
+    end
+
+    def add_theme(theme)
+      themes << theme
+    end
+
+    def each(&block)
+      themes.each(&block)
+    end
+
+    def current_theme
+      themes.find { |theme| theme.active? }
+    end
+
+    def activate_theme(name)
+      theme = themes.find { |theme| theme.name == name }
+
+      if theme
+        current_theme.disable if current_theme
+        theme.activate
+        true
+      end
+    end
+
+    def activate_theme_intelligently
+      if Pry::Helpers::BaseHelpers.windows?
+        activate_theme('pry-classic-16')
+      else
+        case PryTheme.tput_colors
+        when 256 then activate_theme('pry-classic-256')
+        when 16  then activate_theme('pry-classic-16')
+        else          activate_theme('pry-classic-8')
+        end
+      end
+    end
+
+    def reload_theme(name, file)
+      @themes.delete_if { |theme| theme.name == name }
+      load file
+      activate_theme(name)
+      true
+    end
+
+  end
+end

data/lib/pry-theme/when_started_hook.rb

@@ -1,38 +1,36 @@
-require 'fileutils'
-
 module PryTheme
   class WhenStartedHook
-    include PryTheme::Helper
-
     def call(target, options, _pry_)
-      FileUtils.mkdir_p(THEME_DIR) unless File.exists?(THEME_DIR)
+      recreate_user_themes_from_default_ones
+      load_themes
+
+      if Pry.config.theme
+        ThemeList.activate_theme(Pry.config.theme)
+      else
+        ThemeList.activate_theme_intelligently
+      end
+    end
+
+    private
 
-      example_themes.each do |theme|
-        # Copy a default theme to theme directory if it isn't there yet. Update
-        # an installed theme if a theme from the gem has a more recent version
-        # (version determines by theme's meta information).
-        if File.exists?(local_theme(theme))
-          new_version = theme_file_version(default_theme(theme))
-          old_version = theme_file_version(local_theme(theme))
+    # Copy a default theme to theme directory, but only if it isn't there yet.
+    def recreate_user_themes_from_default_ones
+      FileUtils.mkdir_p(USER_THEMES_DIR) unless File.exists?(USER_THEMES_DIR)
+      default_themes = Dir.entries(DEF_THEMES_DIR) - %w{. ..}
 
-          if new_version > old_version
-            FileUtils.cp(default_theme(theme), THEME_DIR)
-          end
-        else
-          FileUtils.cp(default_theme(theme), THEME_DIR)
+      default_themes.each do |theme|
+        user_theme_path = File.join(USER_THEMES_DIR, theme)
+        unless File.exists?(user_theme_path)
+          def_theme_path = File.join(DEF_THEMES_DIR, theme)
+          FileUtils.cp(def_theme_path, USER_THEMES_DIR)
         end
       end
+    end
 
-      if Pry.config.theme
-        if Helper.installed?(Pry.config.theme)
-          PryTheme.set_theme(Pry.config.theme)
-        else
-          _pry_.output.puts %{Can't find "#{ Pry.config.theme }" theme. Using "#{ DEFAULT_THEME_NAME }"}
-          PryTheme.set_theme(DEFAULT_THEME_NAME)
-        end
-      else
-        _pry_.output.puts %{Can't find `Pry.config.theme` definition in your `~/.pryrc`.\nUsing "#{ DEFAULT_THEME_NAME }" theme now.}
-        PryTheme.set_theme(DEFAULT_THEME_NAME)
+    def load_themes
+      user_themes = Dir[File.join(USER_THEMES_DIR, '*' + PT_EXT)]
+      user_themes.each do |theme|
+        require theme
       end
     end
 

data/lib/pry-theme.rb

@@ -1,174 +1,100 @@
-require 'pry-theme/version'
-require 'pry-theme/helper'
-require 'pry-theme/palette'
-require 'pry-theme/term_notation'
-require 'pry-theme/theme'
+require 'fileutils'
+
+require 'pry-theme/theme_list'
+require 'pry-theme/when_started_hook'
+require 'pry-theme/hex'
 require 'pry-theme/rgb'
-require 'pry-theme/color_converter'
+require 'pry-theme/term'
+require 'pry-theme/formattable'
+require 'pry-theme/declaration'
+require 'pry-theme/definition'
+require 'pry-theme/theme'
+require 'pry-theme/preview'
+require 'pry-theme/color'
+require 'pry-theme/color_table'
+require 'pry-theme/basic_editor'
 require 'pry-theme/commands'
-require 'pry-theme/when_started_hook'
-
-require 'yaml'
 
 module PryTheme
 
-  # The root path for PryTheme source codes.
-  ROOT = File.expand_path(File.dirname(__FILE__))
-
-  # The root path for PryTheme examples.
-  EXAMPLES_ROOT = File.join(ROOT, "..", "themes")
-
-  # The root path for the directory with configuration files for OS you're using.
-  CONFIG_DIR = case RbConfig::CONFIG["host_os"]
-               when /mingw|mswin/
-                 File.join(ENV["APPDATA"], "pry-theme")
-               else
-                 # /darwin|linux/ and friends.
-                 File.join(ENV["HOME"], ".pry")
-               end
-
-  # Pry themes' directory.
-  THEME_DIR = File.join(CONFIG_DIR, "themes")
-
-  # The name of the default theme of Pry Theme.
-  DEFAULT_THEME_NAME = "pry-classic"
-
-  # The URI for GitHub API link to Pry Theme Collection contents.
-  COLLECTION = "https://api.github.com/repos/kyrylo/pry-theme-collection/contents"
-
-  def self.set_theme(theme_name)
-    return unless theme = PryTheme.convert(theme_name)
-    ::CodeRay::Encoders::Terminal::TOKEN_COLORS.merge!(theme)
-    @current_theme = theme_name
-  end
-
-  def self.current_theme
-    @current_theme
-  end
-
-  def self.convert(theme_name)
-    begin
-      theme = Theme.new(theme_name)
-    rescue NoThemeError => no_theme_error
-      warn no_theme_error
-      return
-    rescue ThemeDescriptionError => long_descr
-      Pry.output.puts long_descr
-      Pry.output.puts "Using #{DEFAULT_THEME_NAME} theme."
-      return
-    end
-
-    palette = Palette.new(theme.color_depth)
-    scheme  = {}
+  # The VERSION file must be in the root directory of the library.
+  VERSION_FILE = File.expand_path('../../VERSION', __FILE__)
 
-    theme.scheme.each_pair do |k, v|
-      if v.is_a?(Hash)
-        nested_h = {}
+  VERSION = File.exist?(VERSION_FILE) ?
+    File.read(VERSION_FILE).chomp : '(could not find VERSION file)'
 
-        v.each_pair do |nested_k, nested_v|
-          nested_h[nested_k.to_sym] = color_to_term(nested_v, palette)
-        end
+  # The root path of Pry Theme source code.
+  ROOT = File.expand_path(File.dirname(__FILE__))
 
-        scheme[k.to_sym] = nested_h
-      else
-        scheme[k.to_sym] = color_to_term(v, palette)
-      end
+  # The path of the directory with Pry configuration files.
+  CONFIG_DIR = File.join(ENV['HOME'], '.pry')
+
+  # The path of the default Pry Theme themes.
+  DEF_THEMES_DIR = File.join(ROOT, '..', 'themes')
+
+  # The path where the user should keep their themes.
+  USER_THEMES_DIR = File.join(CONFIG_DIR, 'themes')
+
+  # Every Pry Theme file must end with this extension.
+  PT_EXT = '.prytheme.rb'
+
+  # Pry Theme Collection.
+  PTC = 'https://api.github.com/repos/kyrylo/pry-theme-collection/contents/'
+
+  # The default URL shortener (used for listing themes from PTC).
+  SHORTENER = 'http://is.gd/create.php?format=simple&url='
+
+  # @since 0.2.0
+  # @api public
+  class << self
+    # @see https://github.com/kyrylo/pry-theme/wiki/Creating-a-New-Theme
+    #
+    # Creates a new Pry Theme theme.
+    #
+    # @example
+    #   my_theme = PryTheme.create name: 'my-theme', color_model: 8 do
+    #     author name: 'John Doe', email: 'johndoe@example.com'
+    #     description 'My first theme'
+    #
+    #     define_theme do
+    #       class_variable 'red'
+    #       integer 'black'
+    #       method 'white', 'red'
+    #       symbol bg: 'yellow'
+    #
+    #       string do
+    #         content 'blue', 'black'
+    #       end
+    #     end
+    #   end
+    #
+    #   my_theme.definition.class_variable.foreground(true) #=> "red"
+    #   my_theme.definition.string.content.background(true) #=> "black"
+    #
+    # @param [Hash] config
+    # @option config [String] :name ('prytheme-\d+') The name of the theme. It
+    #   must be no longer than 18 characters
+    # @option config [Integer] :color_model (256) The number of colours
+    #   available in the theme that is being created. Besides 256, valid
+    #   arguments are `8` and `16`
+    def create(config = {}, &block)
+      Theme.new(config, &block)
     end
 
-    scheme
-  end
-
-  def self.color_to_term(color, palette)
-    color_pattern = /
-                      \A
-
-                      # Matches "yellow".
-                      (
-                        (
-                          \w+(0[1-9])?
-                        )
-                        \s?
-                      )?
-
-                      # Matches "yellow (bu)" or "(bu)".
-                      (
-                        \(
-                          (
-                            d?b?u?i? # Order matters.
-                          )
-                        \)
-                      )?
-
-
-                      # Matches "yellow (bu) on red" or "on red".
-                      (
-                        \s?
-                        on\s
-                        (
-                          \w+(0[1-9])?
-                        )
-                      )?
-
-                      \z
-                    /x
-
-    if color
-      m = color.match(color_pattern)
-
-      color_fg   = find_color($2, palette) { |c| c.term }
-
-      formatting = if $5
-                     formatting = $5.each_char.map do |ch|
-                       Formatting::ATTRIBUTES[ch]
-                     end
-                   end
-
-      color_bg   = find_color($7, palette) do |c|
-                     if palette.color_depth == 256
-                       "#{ TermNotation::BACKGROUND256 }#{c.term}"
-                      else
-                        Formatting::BACKGROUNDS[c.human.to_s]
-                     end
-                   end
-
-      # Uh oh :(
-      notation = if !color_fg
-                   TermNotation::NO_FOREGROUND
-                 elsif palette.notation
-                   palette.notation[0..-2]
-                 else
-                   nil
-                 end
-
-      [notation, color_fg, formatting, color_bg].flatten.compact.join(";")
-    else
-      # In cases when a user decided not to provide an argument value in theme,
-      # use default color. Not handling this situation results in CodeRay's
-      # error ("can't convert nil into String" stuff).
-      TermNotation::EMPTY
+    # @return [Integer] the number of supported terminal colours. Always equal
+    #   to 16 on Windows.
+    def tput_colors
+      `tput colors`.to_i
+    rescue Errno::ENOENT
+      16
     end
-  rescue NoColorError => e
-    Pry.output.puts "#{e}: wrong color value: `#{color}`. Typo?"
-  end
-
-  def self.find_color(color, palette, &block)
-    if color
-      c = palette.colors.find do |palette_color|
-        palette_color.human == color.to_sym
-      end
 
-      if c
-        block.call(c)
-      else
-        raise NoColorError
-      end
+    # @param [Integer] color
+    # @return [Class] the class, which corresponds to the given +color+
+    def color_const(color)
+      const_get(:"Color#{ color }")
     end
   end
 
+  Pry.config.hooks.add_hook(:when_started, :pry_theme, WhenStartedHook.new)
 end
-
-# Apply a theme of a user from their theme file.
-Pry.config.hooks.add_hook(:when_started, :apply_user_theme, PryTheme::WhenStartedHook.new)
-
-# Import the PryTheme commands.
-Pry.config.commands.import PryTheme::Commands

data/pry-theme.gemspec

@@ -1,24 +1,20 @@
-unless defined? PryTheme::VERSION
-  require File.expand_path('../lib/pry-theme/version', __FILE__)
-end
-
 Gem::Specification.new do |s|
-  s.name         = "pry-theme"
-  s.version      = PryTheme::VERSION
+  s.name         = 'pry-theme'
+  s.version      = File.read('VERSION')
   s.date         = Time.now.strftime('%Y-%m-%d')
-  s.summary      = "Easy way to customize your Pry colors"
-  s.description  = "The plugin enables color theme support for your Pry. No more .pryrc bustling."
-  s.author       = "Kyrylo Silin"
-  s.email        = "kyrylosilin@gmail.com"
-  s.homepage     = "https://github.com/kyrylo/pry-theme"
-  s.licenses     = "zlib"
+  s.summary      = 'An easy way to customize Pry colors via theme files'
+  s.description  = 'The plugin enables color theme support for Pry.'
+  s.author       = 'Kyrylo Silin'
+  s.email        = 'kyrylosilin@gmail.com'
+  s.homepage     = 'https://github.com/kyrylo/pry-theme'
+  s.licenses     = 'zlib'
 
-  s.require_path = "lib"
-  s.files        = `git ls-files`.split "\n"
+  s.require_path = 'lib'
+  s.files        = `git ls-files`.split("\n")
 
-  s.add_runtime_dependency "json"
+  s.add_runtime_dependency 'json'
 
-  s.add_development_dependency "bacon"
-  s.add_development_dependency "rake"
-  s.add_development_dependency "pry"
+  s.add_development_dependency 'bacon'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'pry'
 end