RubyGems - Fingertips-jewelry_portfolio - Versions diffs - 0.1.0 - Mend

Fingertips-jewelry_portfolio 0.1.0

Files changed (22) hide show

data/README.rdoc +107 -0
data/VERSION.yml +4 -0
data/lib/jewelry_portfolio.rb +47 -0
data/lib/jewelry_portfolio/repo.rb +43 -0
data/lib/jewelry_portfolio/repos_index.rb +111 -0
data/lib/jewelry_portfolio/tasks.rb +67 -0
data/lib/jewelry_portfolio/template.rb +62 -0
data/test/fixtures/alloy.github.com.tgz +0 -0
data/test/fixtures/dr-nic-magic-awesome.gemspec_ +15 -0
data/test/fixtures/dr-nic-magic-awesome.html +2 -0
data/test/fixtures/dr-nic-magic-awesome_repo.yml +17 -0
data/test/fixtures/microgem.gemspec_ +19 -0
data/test/fixtures/repo.html.erb +2 -0
data/test/fixtures/repos.yml +109 -0
data/test/fixtures/template.html +8 -0
data/test/fixtures/template.html.erb +5 -0
data/test/jewelry_portfolio_test.rb +71 -0
data/test/repo_test.rb +44 -0
data/test/repos_index_test.rb +206 -0
data/test/template_test.rb +83 -0
data/test/test_helper.rb +29 -0
metadata +87 -0

data/README.rdoc ADDED Viewed

@@ -0,0 +1,107 @@
+= JewelryPortfolio
+Surely also lazy developers like to showcase their jewelry portfolio on their
+GitHub pages.
+Imagine writing an erb template once and use <tt>rake release</tt> to release
+your gem with Jeweler as usual, but in addition re-generate and push the
+index.html for your GitHub pages. If that sounds good to you, you're in luck.
+Because that's exactly what this add-on for
+Jeweler[http://github.com/technicalpickles/jeweler/tree/master] does.
+== Usage
+=== GitHub pages repository
+First things first; create a GitHub pages repository if you haven't done so
+already. See http://github.com/guides/pages for more info.
+Then create the following files, and content, in the gh-pages branch of your
+pages repository (<em>for a more elaborate example see:
+http://github.com/alloy/alloy.github.com/tree/gh-pages</em>):
+* <b>Rakefile:</b>
+    require 'jewelry_portfolio/tasks'
+    JewelryPortfolio::Tasks.new do |t|
+      # Only specify the account if it's different from `github.user' in the git config.
+      t.account = 'Fingertips'
+    end
+* <b>template.html.erb:</b>
+  This is the main template file which will be used to generate the index.html
+  file. All repositories and their gem specifications are available as the
+  local variable <tt>repos</tt>. See JewelryPortfolio::Template and
+  JewelryPortfolio::Repo for more information.</em>.
+    <html>
+      <head>
+        <title>Alloy&rsquo;s jewelry</title>
+      </head>
+      <p>This is an overview of the available gems by Eloy Duran, aka `alloy'.</p>
+      <body>
+        <% repos.each do |repo| %>
+          <%= repo_partial(repo) %>
+        <% end %>
+      </body>
+    </html>
+* <b>repo.html.erb:</b>
+  This file is completely optional; it's just a showcase of using a repo
+  partial.
+    <div>
+      <h1><a href="<%= repo.url %>"><%= spec.name %> <%= spec.version %></a></h1>
+      <p><%= spec.description %></p>
+      <p>Install: <code>$ <%= repo.gem_install_command %></code></p>
+      <p>Clone: <code>$ git clone <%= repo.clone_url %></code></p>
+    </div>
+Now you can generate the index.html file with:
+  $ rake portfolio:generate
+Since you haven't added any projects yet the generated index will be pretty
+dull. But for now just release this version:
+  $ rake portfolio:release
+Whenever you update the template you can use these tasks to preview and/or
+release it.
+=== Add super-cow powers to your project's Rakefile
+Update the Rakefile of the project that you would like to include in your
+jewelry portfolio like so:
+  begin
+    require 'jeweler'
+    Jeweler::Tasks.new do |s|
+      # ...
+    end
+    # Add the following to your Rakefile to use JewelryPortfolio
+    begin
+      require 'jewelry_portfolio/tasks'
+    rescue LoadError
+      puts "JewelryPortfolio not available. Install it with: sudo gem install Fingertips-jewelry_portfolio -s http://gems.github.com"
+    end
+  rescue LoadError
+    puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+  end
+From now on, whenever you use the +release+ rake task, the GitHub pages
+index.html will be re-generated and pushed to GitHub after releasing the gem.
+If you just want to re-generate, or release, the jewelry portfolio use the
+aforementioned <tt>portfolio:generate</tt> and <tt>portfolio:release</tt> rake
+tasks.
+== COPYRIGHT
+Copyright (c) 2009 Fingertips, Eloy Duran. See LICENSE for details.

data/VERSION.yml ADDED Viewed

@@ -0,0 +1,4 @@
+---
+:minor: 1
+:patch: 0
+:major: 0

data/lib/jewelry_portfolio.rb ADDED Viewed

@@ -0,0 +1,47 @@
+require 'jewelry_portfolio/repo'
+require 'jewelry_portfolio/repos_index'
+require 'jewelry_portfolio/template'
+class JewelryPortfolio
+  class FileMissingError < StandardError; end
+  attr_reader :account, :spec, :index, :template
+  # Initializes a JewelryPortfolio instance for the specified +account+.
+  #
+  # If an optional +spec+ is provided it will be added to, or updated in, the
+  # index. If no +spec+ is provided it is assumed you are working in a clone of
+  # your GitHub pages repo. In this case no fetching and merging will be
+  # performed.
+  def initialize(account, spec = nil)
+    @account  = account
+    @spec     = spec
+    @index    = ReposIndex.new(@account, (Dir.pwd unless @spec))
+    @template = Template.new(File.join(@index.path, 'template'), @index.repos)
+    @index.add(@spec) if @spec
+  end
+  # Renders the index.html file.
+  def render!
+    puts "Generating html"
+    File.open(File.join(@index.path, 'index.html'), 'w') { |f| f << @template.render }
+  end
+  # Renders the index.html file, then commits and pushes it to the remote.
+  def release!
+    render!
+    @index.commit! commit_message
+    @index.push!
+  end
+  private
+  def commit_message
+    if @spec
+      "Updated github pages for: #{@spec.name}-#{@spec.version}"
+    else
+      "Re-generated github pages"
+    end
+  end
+end

data/lib/jewelry_portfolio/repo.rb ADDED Viewed

@@ -0,0 +1,43 @@
+class JewelryPortfolio
+  class Repo
+    attr_accessor :spec, :account
+    def initialize(spec, account)
+      @spec, @account = spec, account
+    end
+    # Returns the name of the gem.
+    def name
+      @spec.name
+    end
+    # Returns the URL to the project page on GitHub.
+    def url
+      "http://github.com/#{@account}/#{name}/tree/master"
+    end
+    # Returns the public clone URL.
+    def clone_url
+      "git://github.com/#{@account}/#{name}.git"
+    end
+    # Returns the name of the gem file from GitHub, which is made up of the
+    # account name and the gem name.
+    def gem_name
+      "#{@account}-#{name}"
+    end
+    # Returns the command to install the gem. This is a helper for your views.
+    def gem_install_command
+      "sudo gem install #{gem_name} -s http://gems.github.com"
+    end
+    def ==(other)
+      other.is_a?(Repo) && name == other.name
+    end
+    def inspect
+      "#<#{self.class.name} name=\"#{name}\">"
+    end
+  end
+end

data/lib/jewelry_portfolio/repos_index.rb ADDED Viewed

@@ -0,0 +1,111 @@
+require 'git'
+require 'rubygems/specification'
+require 'tempfile'
+require 'yaml'
+class JewelryPortfolio
+  class ReposIndex
+    attr_reader :account
+    def initialize(account, custom_work_directory = nil)
+      @account, @custom_work_directory = account, custom_work_directory
+    end
+    def url
+      "git@github.com:#{@account}/#{repo_name}"
+    end
+    def path
+      @path ||= @custom_work_directory || File.join(Dir.tmpdir, repo_name)
+    end
+    def repo_name
+      @repo_name ||= "#{@account}.github.com.git"
+    end
+    def pages_repo
+      load_pages_repo!
+      @pages_repo
+    end
+    def repos_file
+      File.join(path, 'repos.yml')
+    end
+    def specs
+      unless @specs
+        load_pages_repo!
+        @specs = File.exist?(repos_file) ? YAML.load(File.read(repos_file)) : []
+      end
+      @specs
+    end
+    def repos
+      specs.map { |spec| Repo.new(spec, @account) }
+    end
+    def add(spec)
+      if old_spec = specs.find { |s| s.name == spec.name }
+        specs[specs.index(old_spec)] = spec
+      else
+        specs << spec
+      end
+      update_repos_file!
+    end
+    def commit!(message)
+      pages_repo.add
+      reraise_with_path { pages_repo.commit(message) }
+    end
+    def push!
+      puts "Pushing branch `gh-pages' to remote `#{url}'"
+      reraise_with_path { pages_repo.push('origin', 'gh-pages') }
+    end
+    def to_yaml
+      specs.to_yaml
+    end
+    private
+    def reraise_with_path
+      begin
+        yield
+      rescue Git::GitExecuteError => e
+        raise Git::GitExecuteError, "[#{path}] #{e.message}"
+      end
+    end
+    def update_repos_file!
+      File.open(repos_file, 'w') { |f| f << to_yaml }
+    end
+    def load_pages_repo!
+      (File.exist?(path) ? open_existing_repo! : open_new_repo!) unless @pages_repo
+    end
+    def open_existing_repo!
+      reraise_with_path do
+        @pages_repo = Git.open(path)
+        unless @custom_work_directory
+          puts "Pulling `#{url}'"
+          @pages_repo.checkout('gh-pages')
+          @pages_repo.fetch('origin')
+          @pages_repo.merge('origin/gh-pages')
+        end
+      end
+    end
+    def open_new_repo!
+      reraise_with_path do
+        puts "Cloning `#{url}'"
+        @pages_repo = Git.clone(url, repo_name, :path => File.dirname(path))
+        @pages_repo.checkout('origin/gh-pages')
+        branch = @pages_repo.branch('gh-pages')
+        branch.create
+        branch.checkout
+      end
+    end
+  end
+end

data/lib/jewelry_portfolio/tasks.rb ADDED Viewed

@@ -0,0 +1,67 @@
+require 'jewelry_portfolio'
+if defined?(Jeweler)
+  class Jeweler
+    alias_method :release_before_jewelry_portfolio, :release
+    def release
+      release_before_jewelry_portfolio
+      Rake::Task['portfolio:release'].invoke
+    end
+  end
+end
+class JewelryPortfolio
+  class Tasks
+    # Override this if this project is on another account than the one
+    # specified by `github.user' in your global or local git config.
+    attr_accessor :account
+    # Initialize the JewelryPortfolio rake tasks. The instance is yielded so
+    # additional configuration can be performed.
+    #
+    #   JewelryPortfolio::Tasks.new do |t|
+    #     t.account = 'Fingertips'
+    #   end
+    def initialize
+      yield self if block_given?
+      @account ||= github_username
+      unless @account
+        raise ArgumentError, "Unable to determine `account'. Add a github user entry to your global, or local, git config. Or explicitely set the `account' on the JewelryPortfolio::Tasks instance."
+      end
+      define
+    end
+    private
+    def define
+      namespace :portfolio do
+        desc "Generate the HTML"
+        task :generate do
+          portfolio.render!
+          sh "open '#{File.join(portfolio.index.path, 'index.html')}'"
+        end
+        desc "Generates the HTML and commits and pushes the new release"
+        task :release do
+          portfolio.release!
+        end
+      end
+    end
+    def portfolio
+      if @portfolio.nil?
+        if spec_file = Dir.glob('*.gemspec').first
+          spec = eval(File.read(spec_file))
+        end
+        @portfolio = JewelryPortfolio.new(@account, spec)
+      end
+      @portfolio
+    end
+    def github_username
+      Git.open('.').config['github.user']
+    end
+  end
+end

data/lib/jewelry_portfolio/template.rb ADDED Viewed

@@ -0,0 +1,62 @@
+require 'erb'
+class JewelryPortfolio
+  # This class is responsible for rendering a template.
+  class Template
+    attr_reader :template, :repos, :view_path
+    # Initialize with the path to the +template+, minus the extensions, and an
+    # array of JewelryPortfolio::Repo instances as +repos+.
+    def initialize(template, repos)
+      template   = File.expand_path(template)
+      @view_path = File.dirname(template)
+      @template  = html_template_file(File.basename(template))
+      @repos     = repos
+    end
+    # Renders the template and returns the output.
+    def render
+      erb @template, binding
+    end
+    # Renders a partial specified by +partial_name+ minus the extension. You
+    # can optionally specify a hash of +local_variables+ which will be
+    # available while rendering the partial.
+    #
+    # Consider a partial named <tt>foo.html.erb</tt>, in the same directory as
+    # the template, containing the following:
+    #
+    #   Text: <%= text %>
+    #
+    # This partial can now be rendered like this:
+    #
+    #   partial('foo', :text => 'bar') # => "Text: bar"
+    def partial(partial_name, local_variables = {})
+      for (var_name, var_value) in local_variables
+        eval "#{var_name} = var_value"
+      end
+      erb html_template_file(partial_name), binding
+    end
+    # Renders a partial for the specified +repo+. This method looks for a
+    # partial file named <tt>repo.html.erb</tt> in the same directory as the
+    # template.
+    #
+    # See partial for more info.
+    def repo_partial(repo, local_variables = {})
+      partial 'repo', local_variables.merge(:repo => repo, :spec => repo.spec)
+    end
+    private
+    def erb(file, binding)
+      ERB.new(File.read(file)).result(binding)
+    end
+    def html_template_file(name)
+      path = File.join(view_path, "#{name}.html.erb")
+      raise FileMissingError, "Could not find template at path `#{path}'" unless File.exist?(path)
+      path
+    end
+  end
+end

data/test/fixtures/alloy.github.com.tgz ADDED Viewed

Binary file

data/test/fixtures/dr-nic-magic-awesome.gemspec_ ADDED Viewed

@@ -0,0 +1,15 @@
+Gem::Specification.new do |spec|
+  spec.name = 'dr-nic-magic-awesome'
+  spec.version = '1.0.0'
+  spec.author = 'John Barnette'
+  spec.email = 'jbarnette@example.com'
+  spec.description = spec.summary = %{ Magically fix your projects overnight! }
+  spec.files = Dir['lib/**/*.rb', 'bin/*', '[A-Z]*', 'test/**/*']
+  spec.has_rdoc = true
+  spec.extra_rdoc_files = %w{ README.rdoc LICENSE TODO }
+  spec.rdoc_options << '--charset=utf-8' << '--main' << 'README.rdoc'
+end

data/test/fixtures/dr-nic-magic-awesome.html ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ <h1>dr-nic-magic-awesome</h1>
2	+ <p>Magically fix your projects overnight!</p>

data/test/fixtures/dr-nic-magic-awesome_repo.yml ADDED Viewed

@@ -0,0 +1,17 @@
+--- !ruby/object:JewelryPortfolio::Repo
+spec: |-
+  Gem::Specification.new do |spec|
+    spec.name = 'dr-nic-magic-awesome'
+    spec.version = '1.0.0'
+    spec.author = 'John Barnette'
+    spec.email = 'jbarnette@example.com'
+    spec.description = spec.summary = %{ Magically fix your projects overnight! }
+    spec.files = Dir['lib/**/*.rb', 'bin/*', '[A-Z]*', 'test/**/*']
+    spec.has_rdoc = true
+    spec.extra_rdoc_files = %w{ README.rdoc LICENSE TODO }
+    spec.rdoc_options << '--charset=utf-8' << '--main' << 'README.rdoc'
+  end

data/test/fixtures/microgem.gemspec_ ADDED Viewed

@@ -0,0 +1,19 @@
+Gem::Specification.new do |spec|
+  spec.name = 'microgem'
+  spec.version = '0.2.0'
+  spec.author = 'Eloy Duran'
+  spec.email = 'eloy.de.enige@gmail.com'
+  spec.description = spec.summary = %{
+    MicroGem provides a simple naive replacement for the `gem install' command
+    in the form of the `mgem' commandline utility.
+  }
+  spec.executables << 'ugem'
+  spec.files = Dir['lib/**/*.rb', 'bin/*', '[A-Z]*', 'test/**/*']
+  spec.has_rdoc = true
+  spec.extra_rdoc_files = %w{ README.rdoc LICENSE TODO }
+  spec.rdoc_options << '--charset=utf-8' << '--main' << 'README.rdoc'
+end

data/test/fixtures/repo.html.erb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ <h1><%= spec.name %></h1>
2	+ <p><%= repo.spec.description %></p>

data/test/fixtures/repos.yml ADDED Viewed

@@ -0,0 +1,109 @@
+---
+- !ruby/object:Gem::Specification
+  name: dr-nic-magic-awesome
+  version: !ruby/object:Gem::Version
+    version: 1.0.0
+  platform: ruby
+  authors:
+  - John Barnette
+  autorequire:
+  bindir: bin
+  cert_chain: []
+  date: &id001 2009-02-27 00:00:00 +01:00
+  default_executable:
+  dependencies: []
+  description: Magically fix your projects overnight!
+  email: jbarnette@example.com
+  executables: []
+  extensions: []
+  extra_rdoc_files:
+  - README.rdoc
+  - LICENSE
+  - TODO
+  files: []
+  has_rdoc: true
+  homepage:
+  post_install_message:
+  rdoc_options:
+  - --charset=utf-8
+  - --main
+  - README.rdoc
+  require_paths:
+  - lib
+  required_ruby_version: !ruby/object:Gem::Requirement
+    requirements: &id002
+      - - ">="
+        - !ruby/object:Gem::Version
+          version: "0"
+    version:
+  required_rubygems_version: !ruby/object:Gem::Requirement
+    requirements: &id003
+      - - ">="
+        - !ruby/object:Gem::Version
+          version: "0"
+    version:
+  requirements: []
+  rubyforge_project:
+  rubygems_version: 1.3.1
+  signing_key:
+  specification_version: 2
+  summary: Magically fix your projects overnight!
+  test_files: []
+- !ruby/object:Gem::Specification
+  name: microgem
+  version: !ruby/object:Gem::Version
+    version: 0.2.0
+  platform: ruby
+  authors:
+  - Eloy Duran
+  autorequire:
+  bindir: bin
+  cert_chain: []
+  date: *id001
+  default_executable:
+  dependencies: []
+  description: MicroGem provides a simple naive replacement for the `gem install' command in the form of the `mgem' commandline utility.
+  email: eloy.de.enige@gmail.com
+  executables:
+  - ugem
+  extensions: []
+  extra_rdoc_files:
+  - README.rdoc
+  - LICENSE
+  - TODO
+  files: []
+  has_rdoc: true
+  homepage:
+  post_install_message:
+  rdoc_options:
+  - --charset=utf-8
+  - --main
+  - README.rdoc
+  require_paths:
+  - lib
+  required_ruby_version: !ruby/object:Gem::Requirement
+    requirements: *id002
+    version:
+  required_rubygems_version: !ruby/object:Gem::Requirement
+    requirements: *id003
+    version:
+  requirements: []
+  rubyforge_project:
+  rubygems_version: 1.3.1
+  signing_key:
+  specification_version: 2
+  summary: MicroGem provides a simple naive replacement for the `gem install' command in the form of the `mgem' commandline utility.
+  test_files: []

data/test/fixtures/template.html ADDED Viewed

@@ -0,0 +1,8 @@
+<html>
+  <body>
+    <h1>dr-nic-magic-awesome</h1>
+    <p>Magically fix your projects overnight!</p>
+    <h1>microgem</h1>
+    <p>MicroGem provides a simple naive replacement for the `gem install' command in the form of the `mgem' commandline utility.</p>
+  </body>
+</html>

data/test/fixtures/template.html.erb ADDED Viewed

@@ -0,0 +1,5 @@
+<html>
+  <body>
+<%= repos.map { |repo| repo_partial(repo) }.join("\n") %>
+  </body>
+</html>

data/test/jewelry_portfolio_test.rb ADDED Viewed

@@ -0,0 +1,71 @@
+require File.expand_path('../test_helper', __FILE__)
+describe "JewelryPortfolio" do
+  before do
+    JewelryPortfolio::ReposIndex.any_instance.stubs(:url).returns(fixture('alloy.github.com'))
+    JewelryPortfolio::ReposIndex.any_instance.stubs(:path).returns(TMP_PAGES_REPO)
+    JewelryPortfolio::ReposIndex.any_instance.stubs(:puts)
+    FileUtils.rm_rf(TMP_PAGES_REPO)
+    @spec = eval(fixture_read('dr-nic-magic-awesome.gemspec_'))
+    @portfolio = JewelryPortfolio.new('alloy', @spec)
+    @portfolio.stubs(:puts)
+  end
+  it "should add the spec to the index" do
+    JewelryPortfolio::ReposIndex.any_instance.expects(:add).with(@spec)
+    JewelryPortfolio.new('alloy', @spec)
+  end
+  it "should also initialize without gemspec" do
+    JewelryPortfolio::ReposIndex.any_instance.expects(:add).never
+    JewelryPortfolio.new('alloy')
+  end
+  it "should return the local pages repos index" do
+    index = @portfolio.index
+    index.should.be.instance_of JewelryPortfolio::ReposIndex
+    index.repos.map { |r| r.spec.name }.should == %w{ dr-nic-magic-awesome microgem }
+  end
+  it "should return the template" do
+    template = @portfolio.template
+    template.should.be.instance_of JewelryPortfolio::Template
+    template.template.should == File.join(@portfolio.index.path, 'template.html.erb')
+    template.repos.should == @portfolio.index.repos
+  end
+  it "should write out the template" do
+    @portfolio.render!
+    File.read(File.join(@portfolio.index.path, 'index.html')).should == File.read(fixture('template.html'))
+  end
+  it "should render, commit, and push the `gh-pages' branch" do
+    @portfolio.expects(:render!)
+    @portfolio.index.expects(:commit!).with("Updated github pages for: dr-nic-magic-awesome-1.0.0")
+    @portfolio.index.expects(:push!)
+    @portfolio.release!
+  end
+end
+describe "JewelryPortfolio, with a custom work_directory" do
+  before do
+    JewelryPortfolio::ReposIndex.any_instance.stubs(:load_pages_repo!)
+    JewelryPortfolio::Template.stubs(:new)
+    @portfolio = JewelryPortfolio.new('alloy')
+  end
+  it "should initialize the index with the current work directory if no spec is given" do
+    @portfolio.index.instance_variable_get("@custom_work_directory").should == Dir.pwd
+  end
+  it "should render, commit, and push the `gh-pages' branch" do
+    @portfolio.expects(:render!)
+    @portfolio.index.expects(:commit!).with("Re-generated github pages")
+    @portfolio.index.expects(:push!)
+    @portfolio.release!
+  end
+end

data/test/repo_test.rb ADDED Viewed

@@ -0,0 +1,44 @@
+require File.expand_path('../test_helper', __FILE__)
+describe "JewelryPortfolio::Repo" do
+  before do
+    @spec = fixture_eval('dr-nic-magic-awesome.gemspec_')
+    @repo = JewelryPortfolio::Repo.new(@spec, 'alloy')
+  end
+  it "should return the Gem::Specification instance" do
+    @repo.spec.should == @spec
+  end
+  it "should return the name of the gem it represents" do
+    @repo.name.should == 'dr-nic-magic-awesome'
+  end
+  it "should return the url to the github project page" do
+    @repo.url.should == 'http://github.com/alloy/dr-nic-magic-awesome/tree/master'
+  end
+  it "should return the public clone url" do
+    @repo.clone_url.should == 'git://github.com/alloy/dr-nic-magic-awesome.git'
+  end
+  it "should return the gem name" do
+    @repo.gem_name.should == "alloy-dr-nic-magic-awesome"
+  end
+  it "should return the gem install command" do
+    @repo.gem_install_command.should == "sudo gem install #{@repo.gem_name} -s http://gems.github.com"
+  end
+  xit "should return itself serialized as YAML" do
+    @repo.to_yaml.should == fixture_read('dr-nic-magic-awesome_repo.yml')
+  end
+  it "should be equal if the name matches" do
+    JewelryPortfolio::Repo.new(fixture_eval('dr-nic-magic-awesome.gemspec_'), 'alloy').should ==
+      JewelryPortfolio::Repo.new(fixture_eval('dr-nic-magic-awesome.gemspec_'), 'alloy')
+    JewelryPortfolio::Repo.new(fixture_eval('dr-nic-magic-awesome.gemspec_'), 'alloy').should.not ==
+      JewelryPortfolio::Repo.new(fixture_eval('microgem.gemspec_'), 'alloy')
+  end
+end

data/test/repos_index_test.rb ADDED Viewed

@@ -0,0 +1,206 @@
+require File.expand_path('../test_helper', __FILE__)
+describe "JewelryPortfolio::ReposIndex, in general" do
+  before do
+    @index = JewelryPortfolio::ReposIndex.new('alloy')
+  end
+  it "should return the account" do
+    @index.account.should == 'alloy'
+  end
+  it "should return the repo name" do
+    @index.repo_name.should == 'alloy.github.com.git'
+  end
+  it "should return the url to the pages repo" do
+    @index.url.should == "git@github.com:alloy/alloy.github.com.git"
+  end
+  it "should return the path to the tmp checkout of the pages repo" do
+    @index.path.should == File.join(Dir.tmpdir, 'alloy.github.com.git')
+  end
+  it "should return the path to the repos YAML index file" do
+    @index.repos_file.should == File.join(@index.path, 'repos.yml')
+  end
+end
+describe "JewelryPortfolio::ReposIndex, in general, when the user specified a work directory" do
+  before do
+    @index = JewelryPortfolio::ReposIndex.new('alloy', '/path/to/repo')
+    File.stubs(:exist?).with(@index.path).returns(true)
+  end
+  it "should return the path to the tmp checkout of the pages repo" do
+    @index.path.should == '/path/to/repo'
+  end
+  it "should return the path to the repos YAML index file" do
+    @index.repos_file.should == File.join(@index.path, 'repos.yml')
+  end
+  it "should not pull from the remote pages repo when opening the repo" do
+    @index.instance_variable_set("@pages_repo", nil)
+    Git.expects(:open).with(@index.path)
+    Git::Base.any_instance.expects(:pull).never
+    @index.pages_repo
+  end
+end
+describe "JewelryPortfolio::ReposIndex, when working with a pages repo" do
+  before do
+    @index = JewelryPortfolio::ReposIndex.new('alloy')
+    @index.stubs(:url).returns(fixture('alloy.github.com'))
+    @index.stubs(:path).returns(TMP_PAGES_REPO)
+    @index.stubs(:puts)
+  end
+  it "should create a checkout of the pages repo if it doesn't exist yet and return it" do
+    FileUtils.rm_rf(TMP_PAGES_REPO)
+    @index.pages_repo.should.be.instance_of Git::Base
+    File.should.exist File.join(TMP_PAGES_REPO, 'repos.yml')
+  end
+  it "should create a checkout of the pages repo if it doesn't exist when asking for the repos" do
+    FileUtils.rm_rf(TMP_PAGES_REPO)
+    @index.repos
+    File.should.exist File.join(TMP_PAGES_REPO, 'repos.yml')
+  end
+  it "should not create a new checkout if it already exists, but do a pull" do
+    @index.pages_repo # make sure it exists
+    @index.instance_variable_set("@pages_repo", nil)
+    Git.expects(:clone).never
+    Git::Base.any_instance.expects(:checkout).with('gh-pages')
+    Git::Base.any_instance.expects(:fetch).with('origin')
+    Git::Base.any_instance.expects(:merge).with('origin/gh-pages')
+    @index.pages_repo
+  end
+  it "should create and checkout the `gh-pages' branch" do
+    FileUtils.rm_rf(TMP_PAGES_REPO)
+    @index.pages_repo.branch('gh-pages').should.be.current
+    @index.pages_repo.config('branch.gh-pages.remote').should == 'origin'
+    @index.pages_repo.config('branch.gh-pages.merge').should == 'refs/heads/gh-pages'
+  end
+  it "should return the pages repo" do
+    repo = @index.pages_repo
+    repo.should.be.instance_of Git::Base
+  end
+  it "should return an array of specs" do
+    FileUtils.rm_rf(TMP_PAGES_REPO)
+    @index.specs.each { |s| s.should.be.instance_of Gem::Specification }
+    @index.specs.map { |s| s.name }.should == %w{ dr-nic-magic-awesome microgem }
+  end
+  it "should return an empty array if the repos.yml file does not exist yet" do
+    FileUtils.rm(@index.repos_file)
+    @index.specs.should == []
+  end
+  it "should return an array of repos with their gemspecs" do
+    FileUtils.rm_rf(TMP_PAGES_REPO)
+    @index.repos.should == [
+      JewelryPortfolio::Repo.new(fixture_eval('dr-nic-magic-awesome.gemspec_'), 'alloy'),
+      JewelryPortfolio::Repo.new(fixture_eval('microgem.gemspec_'), 'alloy')
+    ]
+  end
+  xit "should serialize the array of repos as YAML" do
+    @index.to_yaml.should == fixture_read('repos.yml')
+  end
+  it "should push the `gh-pages' branch" do
+    @index.pages_repo.expects(:push).with('origin', 'gh-pages')
+    @index.push!
+  end
+  it "should commit the changes to the pages repo" do
+    assert_difference('pages_repo_commits', +1) do
+      File.open(@index.repos_file, 'w') { |f| f << 'foo' }
+      @index.commit!('test commit')
+    end
+  end
+  it "should also commit new files to the pages repo" do
+    assert_difference('pages_repo_commits', +1) do
+      File.open(File.join(@index.path, 'foo'), 'w') { |f| f << 'foo' }
+      @index.commit!('test commit')
+    end
+  end
+  it "should push the `gh-pages' branch" do
+    @index.pages_repo.expects(:push).with('origin', 'gh-pages')
+    @index.push!
+  end
+  it "should add a new spec to the repos.yml" do
+    FileUtils.rm_rf(TMP_PAGES_REPO)
+    @index.repos # make sure its loaded
+    spec = eval(fixture_read('dr-nic-magic-awesome.gemspec_').
+      gsub('dr-nic-magic-awesome', 'dr-nic-magic-awesome-v2'))
+    assert_difference('repos_from_file.length', +1) do
+      @index.add(spec)
+    end
+    repos_from_file.last.name.should == 'dr-nic-magic-awesome-v2'
+  end
+  it "should update an existing spec in the repos.yml" do
+    FileUtils.rm_rf(TMP_PAGES_REPO)
+    @index.repos # make sure its loaded
+    spec = eval(fixture_read('dr-nic-magic-awesome.gemspec_').gsub('1.0.0', '1.1.1'))
+    assert_no_difference('repos_from_file.length') do
+      @index.add(spec)
+    end
+    repos_from_file.first.version.to_s.should == '1.1.1'
+  end
+  it "should re-raise Git::GitExecuteErrors with the repo path prepended" do
+    message = nil
+    @index.commit! 'clean'
+    begin
+      @index.commit! 'error'
+    rescue Git::GitExecuteError => e
+      message = e.message
+    end
+    message.should.match /^\[#{@index.path}\]/
+  end
+  private
+  def repos_from_file
+    YAML.load(File.read(@index.repos_file))
+  end
+  def pages_repo_commits
+    @index.pages_repo.log.size
+  end
+  def assert_difference(eval_str, diff)
+    before = eval(eval_str)
+    yield
+    assert_equal before + diff, eval(eval_str)
+  end
+  def assert_no_difference(eval_str, &block)
+    assert_difference(eval_str, 0, &block)
+  end
+end

data/test/template_test.rb ADDED Viewed

@@ -0,0 +1,83 @@
+require File.expand_path('../test_helper', __FILE__)
+class GemSpecMock
+  attr_accessor :name, :description
+  def initialize(name, description)
+    @name, @description = name, description
+  end
+end
+describe "JewelryPortfolio::Template" do
+  before do
+    @repos = [
+      JewelryPortfolio::Repo.new(GemSpecMock.new('dr-nic-magic-awesome', "Magically fix your projects overnight!"), 'alloy'),
+      JewelryPortfolio::Repo.new(GemSpecMock.new('microgem', "MicroGem provides a simple naive replacement for the `gem install' command in the form of the `mgem' commandline utility."), 'alloy')
+    ]
+    @page = JewelryPortfolio::Template.new(fixture('template'), @repos)
+  end
+  it "should raise a JewelryPortfolio::FileMissingError if the specified template does not exist" do
+    e = nil
+    begin
+      JewelryPortfolio::Template.new('/not/existing/template', @repos)
+    rescue JewelryPortfolio::FileMissingError => e
+    end
+    e.should.be.instance_of JewelryPortfolio::FileMissingError
+    e.message.should == "Could not find template at path `/not/existing/template.html.erb'"
+  end
+  it "should return the path to the template" do
+    @page.template.should == fixture('template.html.erb')
+  end
+  it "should return the repos" do
+    @page.repos.should == @repos
+  end
+  it "should return the view_path" do
+    @page.view_path.should == FIXTURE_PATH
+  end
+  it "should render with the specified gem repos available as `repos'" do
+    File.stubs(:read).returns('<%= repos.inspect %>')
+    @page.render.should == @repos.inspect
+  end
+  it "should render an ERB partial with the specified local variables" do
+    @page.partial('repo', :repo => @repos.first, :spec => @repos.first.spec).should ==
+      File.read(fixture('dr-nic-magic-awesome.html'))
+  end
+  it "should render an ERB partial with the specified repo and make its spec available" do
+    @page.repo_partial(@repos.first).should ==
+      File.read(fixture('dr-nic-magic-awesome.html'))
+  end
+  it "should render an ERB partial with the specified repo and local variables" do
+    File.stubs(:read).returns('<%= "#{repo.name} #{extra_var}" %>')
+    @page.repo_partial(@repos.first, :extra_var => 'extra_var_value').should == "#{@repos.first.name} extra_var_value"
+  end
+  it "should render an ERB partial with nested partials" do
+    stubs_file_exists_and_returns('parent.html.erb', 'Hello <%= partial "nested1", :text => "world!" %>')
+    stubs_file_exists_and_returns('nested1.html.erb', '<%= text %> <%= partial "nested2", :text => "Wazzup?!" %>')
+    stubs_file_exists_and_returns('nested2.html.erb', '<%= text %>')
+    @page.partial('parent').should == 'Hello world! Wazzup?!'
+  end
+  it "should render the ERB template" do
+    @page.render.should == File.read(fixture('template.html'))
+  end
+  private
+  def stubs_file_exists_and_returns(fixture_name, data)
+    path = File.join(FIXTURE_PATH, fixture_name)
+    File.stubs(:exist?).with(path).returns(true)
+    File.stubs(:read).with(path).returns(data)
+  end
+end

data/test/test_helper.rb ADDED Viewed

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'test/spec'
+require 'mocha'
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'jewelry_portfolio'
+TMP_PATH = File.expand_path('../tmp', __FILE__)
+FileUtils.mkdir_p(TMP_PATH) unless File.exist?(TMP_PATH)
+TMP_PAGES_REPO = File.join(TMP_PATH, 'alloy.github.com.git')
+FIXTURE_PATH = File.expand_path('../fixtures', __FILE__)
+`cd #{FIXTURE_PATH} && tar zxvf alloy.github.com.tgz` unless File.exist?(File.join(FIXTURE_PATH, 'alloy.github.com'))
+class Test::Unit::TestCase
+  def fixture(file)
+    File.join(FIXTURE_PATH, file)
+  end
+  def fixture_read(file)
+    File.read(fixture(file))
+  end
+  def fixture_eval(name)
+    eval(fixture_read(name))
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: Fingertips-jewelry_portfolio
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eloy Duran
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2009-03-01 00:00:00 -08:00
+default_executable:
+dependencies: []
+description: Imagine writing an erb template once and use <tt>rake release</tt> to release your gem with Jeweler as usual, but in addition re-generate and push the index.html for your GitHub pages. If that sounds good to you, you're in luck. Because that's exactly what this add-on for Jeweler[http://github.com/technicalpickles/jeweler/tree/master] does.
+email: eloy.de.enige@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.rdoc
+- VERSION.yml
+- lib/jewelry_portfolio
+- lib/jewelry_portfolio/repo.rb
+- lib/jewelry_portfolio/repos_index.rb
+- lib/jewelry_portfolio/tasks.rb
+- lib/jewelry_portfolio/template.rb
+- lib/jewelry_portfolio.rb
+- test/fixtures
+- test/fixtures/alloy.github.com
+- test/fixtures/alloy.github.com/index.html
+- test/fixtures/alloy.github.com/repo.html.erb
+- test/fixtures/alloy.github.com/repos.yml
+- test/fixtures/alloy.github.com/template.html.erb
+- test/fixtures/alloy.github.com.tgz
+- test/fixtures/dr-nic-magic-awesome.gemspec_
+- test/fixtures/dr-nic-magic-awesome.html
+- test/fixtures/dr-nic-magic-awesome_repo.yml
+- test/fixtures/microgem.gemspec_
+- test/fixtures/repo.html.erb
+- test/fixtures/repos.yml
+- test/fixtures/template.html
+- test/fixtures/template.html.erb
+- test/jewelry_portfolio_test.rb
+- test/repo_test.rb
+- test/repos_index_test.rb
+- test/template_test.rb
+- test/test_helper.rb
+- test/tmp
+- test/tmp/alloy.github.com.git
+- test/tmp/alloy.github.com.git/index.html
+- test/tmp/alloy.github.com.git/repo.html.erb
+- test/tmp/alloy.github.com.git/repos.yml
+- test/tmp/alloy.github.com.git/template.html.erb
+has_rdoc: true
+homepage: http://github.com/alloy/repo_page_san
+post_install_message:
+rdoc_options:
+- --inline-source
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+requirements: []
+rubyforge_project:
+rubygems_version: 1.2.0
+signing_key:
+specification_version: 2
+summary: An add-on for Jeweler for lazy developers who would like to showcase their jewelry portfolio on their GitHub pages.
+test_files: []