radiant-ray-extension 3.0.0.alpha → 3.0.0.pre

data/lib/ray/extension.rb

@@ -1,116 +1,230 @@
-require "fileutils"
+require "multi_json"
 require "open-uri"
 require "rake"
-require "ray/string"
-
-module Extension
-
-  attr_accessor :author,
-                :description,
-                :homepage,
-                :name,
-                :uri,
-                :version
-
-  def initialize options = {}
-    @author       = options[:author]
-    @description  = options[:description]
-    @homepage     = options[:homepage]
-    @name         = options[:name].to_s.to_extension_name
-    @uri          = options[:uri]
-    @version      = options[:version]
-  end
+require "zip"
+require "ray/utility"
 
-  def disable
-    unless File.exist? "#{Ray::EXT_DIR}/#{@name}"
-      raise "The #{@name} extension is not installed"
-    end
+module Ray
 
-    FileUtils.mkdir_p "#{Ray::EXT_DIR}/.disabled"
-    FileUtils.mv "#{Ray::EXT_DIR}/#{@name}", "#{Ray::EXT_DIR}/.disabled/#{@name}"
-  end
+  # Install extensions from RubyGems, GitHub or zip files
+  class Extension
 
-  def enable
-    unless File.exist? "#{Ray::EXT_DIR}/.disabled/#{@name}"
-      raise "The #{@name} extension is not disabled"
+    attr_accessor :name, :uri
+
+    def initialize name = nil, uri = nil
+      @name = name.to_extension_name
+      @uri = uri
     end
 
-    FileUtils.mv "#{Ray::EXT_DIR}/.disabled/#{@name}", "#{Ray::EXT_DIR}/#{@name}"
-  end
+    # Download file to tmp/ray/tempfile
+    def download
+      # set StringMax to 0 so open-uri always creates a tmp file
+      OpenURI::Buffer.send :remove_const, "StringMax"
+      OpenURI::Buffer.const_set "StringMax", 0
 
-  def uninstall
-    unless File.exist? "#{Ray::EXT_DIR}/#{@name}"
-      raise "The #{@name} extension is not installed"
+      FileUtils.mkdir_p TMP
+      tmpfile = open(@uri).path
+      FileUtils.cp tmpfile, "#{TMP}/#{@uri.split('/').last}"
     end
 
-    run_tasks({
-      :migrate  => "VERSION=0",
-      :update   => :psa
-    })
-    FileUtils.rm_rf "#{Ray::EXT_DIR}/#{@name}"
-  end
+    # Move extension to vendor/extensions/name and run Rake tasks
+    def install
+      dir = Dir.glob("#{TMP}/*").reject { |f| File.ftype(f) != "directory" }
+      FileUtils.mv dir.first, "#{EXT_DIR}/#{@name}"
+      FileUtils.rm_r TMP
+      run_rake_tasks
+    end
 
-  def download
-    raise "The extension name is required"  unless @name
-    raise "The extension URI is required"   unless @uri
+    def disable
+      FileUtils.mkdir_p "#{EXT_DIR}/.disabled"
+      FileUtils.mv "#{EXT_DIR}/#{@name}", "#{EXT_DIR}/.disabled/#{@name}"
+    end
 
-    puts "#{@name} => Downloading..."
-    FileUtils.mkdir_p Ray::TMP_DIR
-    tmpfile = open(@uri).path
-    FileUtils.cp tmpfile, "#{Ray::TMP_DIR}/#{@uri.split('/').last}"
-  end
+    def enable
+      FileUtils.mv "#{EXT_DIR}/.disabled/#{@name}", "#{EXT_DIR}/#{@name}"
+    end
 
-  def vendor
-    puts "#{@name} => Vendoring..."
-    directory = Dir.glob("#{Ray::TMP_DIR}/*").first
-    FileUtils.mv directory, "#{Ray::EXT_DIR}/#{@name}"
-  end
+    def uninstall
+      tasks = load_rake_tasks
+      tasks.each do |task|
+        case task
+        when "radiant:extensions:#{@name}:uninstall"
+          run_task "uninstall"
+          break
+        when "radiant:extensions:#{@name}:migrate"
+          run_task "migrate", "VERSION=0"
+        when "radiant:extensions:#{@name}:update"
+          public_service_announcement
+        end
+      end
+      disable
+    end
 
-  def run_tasks options = { :migrate => "", :update => "" }
-    tasks = load_tasks
-    tasks.each do |task|
-      case task
-      when "radiant:extensions:#{@name}:install"
-        run_task "install"
-        break
-      when "radiant:extensions:#{@name}:migrate"
-        run_task "migrate", options[:migrate]
-      when "radiant:extensions:#{@name}:update"
-        run_task "update", options[:update]
+    def public_service_announcement
+      path = "#{EXT_DIR}/#{@name}"
+      stuff_in_public = Dir.glob("#{path}/public/**/*.*").each do |f|
+        f.sub!(/#{path}\//, "")
+      end
+      %Q{
+# The #{@name} extension added the following files to the public directory:
+#   #{stuff_in_public.join("\n#   ")}
+# These files were not deleted in case some other extension might need them.
+}.lstrip unless stuff_in_public.empty?
+    end
+
+    # Load and run appropriate Rake tasks
+    def run_rake_tasks
+      tasks = load_rake_tasks
+      tasks.each do |task|
+        case task
+        when "radiant:extensions:#{@name}:install"
+          run_task "install"
+          break
+        when "radiant:extensions:#{@name}:migrate"
+          run_task "migrate"
+        when "radiant:extensions:#{@name}:update"
+          run_task "update"
+        end
       end
     end
-  end
 
-  def run_task task, options = {}
-    puts "#{@name} => Running #{task} task..."
-    if task == "update" and options == :psa
-      public_service_announcement
-    else
+    # Run a specific Rake task
+    def run_task(task, options = "")
       `rake radiant:extensions:#{@name}:#{task} #{options}`
     end
-  end
 
-  def load_tasks
-    puts "#{@name} => Loading tasks..."
-    rake_file = "#{Ray::ROOT}/vendor/extensions/#{@name}/lib/tasks/#{@name}_extension_tasks.rake"
-    load rake_file if File.exist? rake_file
-    Rake.application.tasks.map(&:name)
-  end
+    # Load Rakefile
+    # @return [Array] List of available tasks
+    def load_rake_tasks
+      rake_file = "#{ROOT}/vendor/extensions/#{@name}/lib/tasks/#{@name}_extension_tasks.rake"
+      load rake_file if File.exist? rake_file
+      Rake.application.tasks.map(&:name)
+    end
 
-  def cleanup
-    puts "#{@name} => Removing temporary files..."
-    FileUtils.rm_rf Ray::TMP_DIR
-  end
+    # Install extensions from zip files
+    class Zip < Extension
+
+      # Extract downloaded zip file to tmp/ray/tempfile
+      def extract
+        begin
+          ::Zip::ZipFile.open Dir.glob("#{TMP}/*").first do |zip_file|
+            zip_file.each do |f|
+              f_path = File.join "#{TMP}", f.name
+              FileUtils.mkdir_p File.dirname f_path
+              zip_file.extract f, f_path unless File.exist? f_path
+            end
+          end
+        rescue ::Zip::ZipError
+          # just for fun let's try gem unpack!
+          Dir.chdir TMP do
+            `gem unpack #{@uri.split('/').last}`
+          end
+        end
+      end
+
+    end
+
+    # Install extensions from Git repositories
+    class Git < Extension
+
+      # Clone repository to tmp/ray/tempfile
+      def clone
+        FileUtils.mkdir_p TMP
+        Dir.chdir TMP do
+          `git clone --depth=1 --quiet #{@uri} #{@name}`
+          FileUtils.rm_rf "#{@name}/.git"
+        end
+      end
+
+    end
+
+    # Install extensions from RubyGems
+    class RubyGem < Extension
+
+      attr_accessor :name, :uri, :version
+
+      def initialize name = nil, uri = nil, version = nil
+        @name = name.to_extension_name
+        @uri = uri
+        @version = version || get_version if @name
+      end
+
+      # Bundle extension
+      def bundle
+        File.open GEMFILE, "a" do |gemfile|
+          gemfile.puts "gem \"radiant-#{@name}-extension\", \"#{@version}\""
+        end
+        `bundle update`
+      end
+      alias enable bundle
+
+      # copy and run Rake tasks
+      def install
+        path = `bundle show radiant-#{@name}-extension`.chomp
+        begin
+          FileUtils.cp "#{path}/lib/tasks/#{@name}_extension_tasks.rake", "#{ROOT}/lib/tasks/"
+        rescue
+        end
+        run_rake_tasks
+      end
+
+      def disable
+        current = File.read GEMFILE
+        updated = current.sub /gem "radiant-#{@name}-extension".+\n/, ""
+        File.open GEMFILE, "w" do |gemfile|
+          gemfile.puts updated
+        end
+        FileUtils.rm "#{GEMFILE}.lock"
+        `bundle update`
+      end
+
+      # def enable
+      #   bundle
+      # end
+
+      def uninstall
+        tasks = load_rake_tasks
+        tasks.each do |task|
+          case task
+          when "radiant:extensions:#{@name}:uninstall"
+            run_task "uninstall"
+            break
+          when "radiant:extensions:#{@name}:migrate"
+            run_task "migrate", "VERSION=0"
+          when "radiant:extensions:#{@name}:update"
+            public_service_announcement
+          end
+        end
+        disable
+      end
+
+      # Load Rakefile
+      # @return [Array] List of available tasks
+      def load_rake_tasks
+        rake_file = "#{ROOT}/lib/tasks/#{@name}_extension_tasks.rake"
+        load rake_file if File.exist? rake_file
+        Rake.application.tasks.map(&:name)
+      end
+
+      def get_version
+        uri = "http://rubygems.org/api/v1/gems/radiant-#{@name}-extension.json"
+        return "~> #{MultiJson.decode(open(uri).read)['version']}"
+      end
+
+      def public_service_announcement
+        path = `bundle show radiant-#{@name}-extension`.chop
+        stuff_in_public = Dir.glob("#{path}/public/**/*.*").each do |f|
+          f.sub!(/#{path}\//, "")
+        end
+        %Q{
+# The #{@name} extension added the following files to the public directory:
+#   #{stuff_in_public.join("\n#   ")}
+# These files were not deleted in case some other extension might need them.
+}.lstrip unless stuff_in_public.empty?
+      end
 
-  def public_service_announcement path = nil
-    path ||= "#{Ray::EXT_DIR}/#{@name}"
-    Dir.glob("#{path}/public/**/*.*").each do |f|
-      FileUtils.rm_rf File.expand_path(f.sub! /#{path}\//, "")
     end
-  end
 
-  def name= name
-    @name = name.to_extension_name
   end
 
 end

data/lib/ray/search.rb

@@ -1,62 +1,217 @@
-require "fileutils"
 require "multi_json"
 require "open-uri"
-require "ray/string"
+require "ray/utility"
 require "yaml"
 
-module Search
+module Ray
 
-  def search
-    normalize open(@uri).read
-  end
+  # Search RubyGems, GitHub and/or the local cache for extension information
+  class Search
+
+    attr_reader :query,
+                :results,
+                :uri
 
-  def cache
-    if File.exist? Ray::CACHE
-      cache = YAML.load_file Ray::CACHE
-    else
-      FileUtils.mkdir_p Ray::RAY
-      FileUtils.touch Ray::CACHE
-      cache = {}
+    def initialize query = nil, live = nil
+      if query
+        @query = query
+        @results = live ? {} : Cache.new(query).results
+        if @results.empty?
+          rubygems = RubyGems.new query
+          github = GitHub.new query
+          @results = github.results.merge rubygems.results
+          @uri = [rubygems.uri, github.uri]
+        end
+      else
+        @results = "A search query is required. Try: ray help search"
+      end
     end
-    File.open Ray::CACHE, "w" do |f|
-      f.write cache.merge(@results).to_yaml
+
+    # Write search results to local cache file
+    # @return [Hash] the original search results
+    def cache
+      if @results.respond_to? :merge
+        if File.exist? CACHE
+          cache = YAML.load_file CACHE
+        else
+          FileUtils.mkdir_p RAY
+          FileUtils.touch CACHE
+          cache = {}
+        end
+        File.open CACHE, "w" do |f|
+          f.write cache.merge(@results).to_yaml
+        end
+      end
+      return self
     end
-    return self
-  end
 
-  def output
-    output = ""
-    if @results.empty?
-      output += %Q{
-No extensions matched: #{@query}
-# URI: #{@uri}
-}.lstrip
-    else
-      @results.each do |extension|
-        name = extension.first.to_extension_name
-        info = extension.last
-        output += %Q{
+    # Pretty printable string; optimized for CLI
+    # @return [String] pretty text ready for output
+    def output
+      if @results =~ /query is required/
+        @results
+      elsif @results.empty?
+        "No extensions matched '#{@query}'"
+      else
+        output = ""
+        @results.each do |extension|
+          name = extension.first.to_extension_name
+          info = extension.last
+          output += %Q{
 #{"-" * 80}
-#{name} (#{info[:version]}) by #{info[:author][0..(78 - "  #{name} (#{info[:version]}) by ".size)]}
+  #{name} (#{info[:version]}) by #{info[:author][0..(78 - "  #{name} (#{info[:version]}) by ".size)]}
 #{info[:description].wrap(78, 2)}
-#{info[:homepage]}
-ray install #{name}\n
+  #{info[:homepage]}
+  ray install #{name}\n
 }.lstrip
+        end
+        return output
       end
-      return output
     end
-  end
 
-  def multiple_choice
-    puts output
-    print "Which extension do you want to install? "
-    choice = STDIN.gets.chomp
-    @results[choice]
-  end
+    # Prompt the user to choose from a list of possible extensions
+    # @return [Hash] Extension information
+    def multiple_choice
+      puts output
+      print "Which extension do you want to install? "
+      choice = STDIN.gets.chomp
+      @results[choice]
+    end
+
+    # Get raw JSON response from search providers
+    # @return [Hash] search results in a normalized format
+    def search
+      normalize open(@uri).read
+    end
+
+    # Search RubyGems for extension information
+    class RubyGems < Search
+
+      attr_reader :query,
+                  :results,
+                  :uri
+
+      def initialize query = nil
+        if query
+          @query = query
+          @uri = "https://rubygems.org/api/v1/search.json?query=radiant-#{query}"
+          @results = search
+        else
+          @results = "A search query is required. Try: ray help search"
+        end
+      end
+
+      # Normalize RubyGems JSON response
+      # @return [Hash] search results in a normalized format
+      def normalize response
+        response = MultiJson.decode response
+        results = {}
+        response.each do |extension|
+          results[extension["name"].to_extension_name] = {
+            :author => extension["authors"],
+            :description => extension["info"],
+            :homepage => extension["homepage_uri"],
+            :name => extension["name"].to_extension_name,
+            :repository => extension["source_code_uri"],
+            :uri => extension["gem_uri"],
+            :version => extension["version"]
+          }
+        end
+        return results
+      end
+
+    end
+
+    # Search GitHub for extension information
+    class GitHub < Search
+
+      attr_reader :query,
+                  :results,
+                  :uri
+
+      def initialize query = nil
+        if query
+          @query = query
+          @uri = "http://github.com/api/v2/json/repos/search/radiant+#{query}"
+          @results = search
+        else
+          @results = "A search query is required. Try: ray help search"
+        end
+      end
+
+      # Normalize GitHub JSON response
+      # @return [Hash] search results in a normalized format
+      def normalize response
+        response = MultiJson.decode response
+        results = {}
+        response["repositories"].each do |extension|
+          results[extension["name"].to_extension_name] = {
+            :author => real_name(extension["owner"]),
+            :description => extension["description"],
+            :homepage => extension["url"],
+            :name => extension["name"].to_extension_name,
+            :repository => "#{extension['url']}.git",
+            :uri => "#{extension['url']}/zipball/master",
+            :version => "latest"
+          }
+        end
+        return results
+      end
+
+      # Use GitHub API v3 to look up the owner's real name
+      # @return [String] the owner's real name
+      # @example
+      #   real_name "saturnflyer" # => "Jim Gay"
+      def real_name owner
+        response = open("https://api.github.com/users/#{owner}").read
+        MultiJson.decode(response)["name"]
+      end
+
+    end
+
+    # Search the local cache for extension information
+    class Cache < Search
+
+      attr_reader :query,
+                  :results,
+                  :uri
+
+      def initialize query = nil
+        if query
+          @query = query
+          @uri = "file:///#{CACHE}"
+          @results = search
+        else
+          @results = "A search query is required. Try: ray help search"
+        end
+      end
+
+      # Override Search#search to use the local cache
+      # @return [Hash] local search results
+      def search
+        return {} unless File.exist? CACHE
+        cache = YAML.load_file CACHE
+        results = {}
+        cache.each do |extension|
+          name = extension.first
+          info = extension.last
+          if "#{name} #{info[:description]}".include? @query
+            results[name] = {
+              :author => info[:author],
+              :description => info[:description],
+              :homepage => info[:homepage],
+              :name => name,
+              :repository => info[:repository],
+              :uri => info[:uri],
+              :version => info[:version]
+            }
+          end
+        end
+        return results
+      end
+
+    end
 
-  def merge other
-    self.results.merge! other.results
-    return self
   end
 
 end

data/lib/ray/utility.rb

@@ -0,0 +1,31 @@
+# String extensions
+class String
+
+  # Turns pretty much any string into a "proper" extension name
+  # @return [String] the string converted to an extension name
+  # @example
+  #   "radiant-example-extension".to_extension_name # => example
+  #   "radiant-my-ext-extension".to_extension_name  # => my_ext
+  #   "monkey-patches".to_extension_name            # => monkey_patches
+  #   "nice_name".to_extension_name                 # => nice_name
+  def to_extension_name
+    name = self.gsub /radiant[-_]/i, ""
+    name.gsub! /[-_]extension/i, ""
+    name.gsub! /-/, "_"
+    return name
+  end
+
+  # Wrap, indent and flare text output
+  # @return [String] the string after mangling
+  def wrap columns = 80, indent = 0, prefix = ""
+    indent = " " * indent
+    self.gsub(/(.{1,#{columns}})( +|$\n?)|(.{1,#{columns}})/,"#{prefix}#{indent}\\1\\3\n")
+  end
+
+end
+
+class NilClass
+  def to_extension_name
+    nil
+  end
+end

data/lib/ray.rb

@@ -1,8 +1,3 @@
 require "ray/constants"
-require "ray/extension/gem"
-require "ray/extension/git"
-require "ray/extension/zip"
-require "ray/search/cache"
-require "ray/search/github"
-require "ray/search/rubygems"
-require "ray/string"
+require "ray/extension"
+require "ray/search"

data/spec/fixtures/cache_single.yml

@@ -2,7 +2,8 @@
 reorder_children:
   :author: Benny Degezelle
   :description: Makes Radiant better by adding reorder_children!
+  :uri: http://rubygems.org/gems/radiant-reorder_children-extension-1.0.5.gem
   :homepage: http://github.com/jomz/radiant-reorder_children-extension
   :name: reorder_children
-  :uri: http://rubygems.org/gems/radiant-reorder_children-extension-1.0.5.gem
+  :repository: 
   :version: 1.0.5