ore-core 0.1.0

data/lib/ore/versions/version_file.rb

@@ -0,0 +1,66 @@
+require 'ore/versions/exceptions/invalid_version'
+require 'ore/versions/version'
+
+require 'yaml'
+
+module Ore
+  module Versions
+    #
+    # Represents a version loaded from a `VERSION` file.
+    #
+    class VersionFile < Version
+
+      # Common `VERSION` file-names.
+      @@files = %w[VERSION VERSION.yml]
+
+      #
+      # Finds the `VERSION` file.
+      #
+      # @param [Project] project
+      #   The Ore project.
+      #
+      # @return [VersionFile, nil]
+      #   The version file of the project.
+      #
+      def self.find(project)
+        @@files.each do |name|
+          return load(project.path(name)) if project.file?(name)
+        end
+
+        return nil
+      end
+
+      #
+      # Loads the version file of the project.
+      #
+      # @param [String] path
+      #   The path to the version file.
+      #
+      # @return [VersionFile]
+      #   The loaded version file.
+      #
+      # @raise [InvalidVersion]
+      #   The `VERSION` file must contain either a `Hash` or a `String`.
+      #
+      def self.load(path)
+        data = YAML.load_file(path)
+
+        case data
+        when Hash
+          self.new(
+            (data[:major] || data['major']),
+            (data[:minor] || data['minor']),
+            (data[:patch] || data['patch']),
+            (data[:build] || data['build'])
+          )
+        when String
+          self.parse(data)
+        else
+          file = File.basename(@path)
+          raise(InvalidVersion,"invalid version data in #{file.dump}")
+        end
+      end
+
+    end
+  end
+end

data/lib/rubygems_plugin.rb

@@ -0,0 +1,40 @@
+module Ore
+  #
+  # Provides transparent access to {Ore::Specification}.
+  #
+  # @param [Symbol] name
+  #   The constant name.
+  #
+  # @return [Object]
+  #   The constant.
+  #
+  # @raise [NameError]
+  #   The constant could not be found.
+  #
+  def self.const_missing(name)
+    if name == :Specification
+      begin
+        # attempt to load 'ore/specification' from the $LOAD_PATH
+        require 'ore/specification'
+      rescue ::LoadError
+        # find our `lib/` directory
+        lib_dir = File.expand_path(File.dirname(__FILE__))
+
+        # modify the $LOAD_PATH is 'ore/specification' is not available
+        $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+
+        begin
+          # attempt loading 'ore/specification' again
+          require 'ore/specification'
+        rescue ::LoadError
+          # ore is probably not installed, so raise a NameError
+          return super(name)
+        end
+      end
+
+      return Ore.const_get(name)
+    end
+
+    super(name)
+  end
+end

data/ore-core.gemspec

@@ -0,0 +1,6 @@
+lib_dir = File.expand_path('lib',File.dirname(__FILE__))
+$LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+
+require 'ore/specification'
+
+Ore::Specification.new

data/spec/dependency_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'ore/dependency'
+
+describe Dependency do
+  subject { Dependency }
+
+  describe "parse" do
+    it "should parse a dependency string with only a name" do
+      dep = subject.parse('foo')
+
+      dep.name.should == 'foo'
+      dep.versions.should be_empty
+    end
+
+    it "should parse a dependency with a version" do
+      dep = subject.parse('foo ~> 1.2.3')
+
+      dep.name.should == 'foo'
+      dep.versions.should == ['~> 1.2.3']
+    end
+  end
+
+  describe "parse_versions" do
+    it "should parse a single version" do
+      dep = subject.parse_versions('foo', '~> 1.2.3')
+
+      dep.versions.should == ['~> 1.2.3']
+    end
+
+    it "should parse multiple versions" do
+      dep = subject.parse_versions('foo', '~> 1.2.3, >= 1.4.0')
+
+      dep.versions.should == ['~> 1.2.3', '>= 1.4.0']
+    end
+  end
+end

data/spec/document_file_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'helpers/files'
+
+require 'ore/document_file'
+
+describe DocumentFile do
+  include Helpers::Files
+
+  subject { DocumentFile.new(file('.document')) }
+
+  it "should parse the file globs from a .document file" do
+    subject.file_globs.to_a.should =~ %w[
+      lib/**/*.rb
+      bin/*
+    ]
+  end
+
+  it "should parse the extra-file globs from a .document file" do
+    subject.extra_file_globs.to_a.should =~ %w[
+      ChangeLog.md
+      COPYING.txt
+    ]
+  end
+
+  it "should not consume the - separator" do
+    subject.file_globs.should_not include('-')
+    subject.extra_file_globs.should_not include('-')
+  end
+end

data/spec/helpers/files.rb

@@ -0,0 +1,7 @@
+module Helpers
+  module Files
+    def file(name)
+      File.join(File.dirname(__FILE__),'files',name)
+    end
+  end
+end

data/spec/helpers/files/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+ChangeLog.md
+COPYING.txt

data/spec/helpers/files/VERSION

@@ -0,0 +1 @@
+1.2.3

data/spec/helpers/files/VERSION.yml

@@ -0,0 +1,5 @@
+---
+:major: 1
+:minor: 2
+:patch: 3
+:build:

data/spec/helpers/projects.rb

@@ -0,0 +1,13 @@
+require 'ore/project'
+
+module Helpers
+  module Projects
+    def project_dir(name)
+      File.join(File.dirname(__FILE__),'projects',name)
+    end
+
+    def project(name)
+      Ore::Project.find(project_dir(name))
+    end
+  end
+end

data/spec/helpers/projects/dm-is-plugin/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/spec/helpers/projects/dm-is-plugin/VERSION

@@ -0,0 +1 @@
+1.2.3

data/spec/helpers/projects/dm-is-plugin/dm-is-plugin.gemspec

@@ -0,0 +1,10 @@
+# -*- encoding: utf-8 -*-
+
+begin
+  Ore::Specification.new do |gemspec|
+    # custom logic here
+  end
+rescue NameError
+  STDERR.puts "The 'dm-is-plugin.gemspec' file requires Ore."
+  STDERR.puts "Run `gem install ore` to install Ore."
+end

data/spec/helpers/projects/dm-is-plugin/gemspec.yml

@@ -0,0 +1,9 @@
+name: dm-is-plugin
+summary: DataMapper Plugin
+description: A plugin for DataMapper
+homepage: http://github.com/datamapper/dm-is-plugin
+email: datamapper@googlegroups.com
+authors: Dan Kubb
+
+dependencies:
+  dm-core: ~> 1.0.0

data/spec/helpers/projects/dm-is-plugin/lib/dm-is-plugin.rb

@@ -0,0 +1,4 @@
+require 'dm-core'
+require 'dm-is-plugin/is/plugin'
+
+DataMapper::Model.append_extensions DataMapper::Is::Plugin

data/spec/helpers/projects/dm-is-plugin/lib/dm-is-plugin/is/plugin.rb

@@ -0,0 +1,6 @@
+module DataMapper
+  module Is
+    module Plugin
+    end
+  end
+end

data/spec/helpers/projects/explicit/gemspec.yml

@@ -0,0 +1,19 @@
+name: Explicit
+summary: An explicit library
+description: This is a library written by strict developers.
+license: MIT
+homepage: http://github.com/user/explicit
+email: user@example.com
+authors:
+  - Senior Software Engineer
+  - Junior Software Engineer
+
+post_install_message: |
+  Thanks for installing the Explicit gem!
+
+  To start Explicit, run the following command:
+
+  $ explicit
+
+required_ruby_version: >= 1.8.7
+required_rubygems_version: >= 1.3.7

data/spec/helpers/projects/explicit/lib/explicit/version.rb

@@ -0,0 +1,15 @@
+module Explicit
+  module Version
+    MAJOR = 1
+
+    MINOR = 2
+
+    PATCH = 3
+
+    VERSION = [MAJOR, MINOR, PATCH].join('.')
+
+    def self.to_s
+      VERSION
+    end
+  end
+end

data/spec/helpers/projects/ffi-binding/gemspec.yml

@@ -0,0 +1,11 @@
+name: ffi-binding
+summary: FFI Binding
+description: FFI Binding for some C library
+homepage: http://github.com/wmeissner/ffi-binding
+email: wmeissner@example.com
+authors: Wayne Meissner
+
+requirements: libstuff >= 1.0
+
+dependencies:
+  ffi: ~> 0.6.0

data/spec/helpers/projects/ffi-binding/lib/ffi/binding/version.rb

@@ -0,0 +1,5 @@
+module FFI
+  module Binding
+    VERSION = '1.2.3'
+  end
+end

data/spec/helpers/projects/jewelery/VERSION

@@ -0,0 +1 @@
+1.2.3

data/spec/helpers/projects/jewelery/bin/jewelery

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+puts 'Built with Jeweler!'

data/spec/helpers/projects/jewelery/gemspec.yml

@@ -0,0 +1,6 @@
+name: Jewelery
+summary: A library created with Jeweler
+description: This is how projects have been layed out in the past.
+homepage: http://github.com/technicalpickles/jewelery
+email: technicalpickles@example.com
+authors: technicalpickles

data/spec/helpers/projects/jewelery/jewelery.gemspec

@@ -0,0 +1,10 @@
+# -*- encoding: utf-8 -*-
+
+begin
+  Ore::Specification.new do |gemspec|
+    # custom logic here
+  end
+rescue NameError
+  STDERR.puts "The 'my-project.gemspec' file requires Ore."
+  STDERR.puts "Run `gem install ore` to install Ore."
+end

data/spec/helpers/projects/jewelery/lib/jewelery.rb

@@ -0,0 +1,4 @@
+require 'jewelery/rubies'
+
+module Jewelery
+end

data/spec/helpers/projects/jewelery/lib/jewelery/rubies.rb

@@ -0,0 +1,4 @@
+module Jewelery
+  class Rubies
+  end
+end

data/spec/helpers/projects/minimal/gemspec.yml

@@ -0,0 +1,4 @@
+version: 1.2.3
+summary: Minimal
+description: Least amount of effort
+authors: me

data/spec/helpers/projects/minimal/lib/minimal.rb

@@ -0,0 +1,2 @@
+module Minimal
+end

data/spec/naming_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+require 'ore/naming'
+
+describe Naming do
+  subject do
+    obj = Object.new
+    obj.extend Ore::Naming
+    obj
+  end
+
+  describe "underscore" do
+    it "should underscore CamelCase names" do
+      subject.underscore('FooBar').should == 'foo_bar'
+    end
+
+    it "should not add leading underscores to Capitalized names" do
+      subject.underscore('Foo').should == 'foo'
+    end
+
+    it "should not add tailing underscores to CamelCase names" do
+      subject.underscore('FooX').should == 'foox'
+    end
+
+    it "should not add underscores when they already exist" do
+      subject.underscore('Foo_Bar').should == 'foo_bar'
+    end
+  end
+
+  it "should guess the module names from a project name" do
+    subject.modules_of('foo-bar').should == ['Foo', 'Bar']
+  end
+
+  it "should filter out obvious names from the module names" do
+    subject.modules_of('ruby-foo').should == ['Foo']
+  end
+
+  it "should recognize common acronyms in project names" do
+    subject.modules_of('ffi-bar').should == ['FFI', 'Bar']
+  end
+
+  it "should guess the namespace from a project name" do
+    subject.namespace_of('foo-bar').should == 'Foo::Bar'
+  end
+
+  it "should guess the namespace directories from a project name" do
+    subject.namespace_dirs_of('foo-bar').should == ['foo', 'bar']
+  end
+
+  it "should filter out namespaces that are rarely used in directory names" do
+    subject.namespace_dirs_of('ruby-foo').should == ['foo']
+  end
+
+  it "should guess the namespace directory from a project name" do
+    subject.namespace_path_of('foo-bar').should == 'foo/bar'
+  end
+end

data/spec/projects/dm_plugin_project_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'helpers/projects'
+require 'projects/project_examples'
+
+describe "DataMapper Plugin project" do
+  include Helpers::Projects
+
+  before(:all) do
+    @project = project('dm-is-plugin')
+  end
+
+  it_should_behave_like 'an Ore Project'
+
+  it "should correctly guess the namespace" do
+    @project.namespace.should == 'DataMapper::Is::Plugin'
+  end
+
+  it "should have a namespace directory" do
+    @project.namespace_dir.should == 'dm-is-plugin'
+  end
+
+  it "should use Bundler" do
+    @project.should be_bundler
+  end
+
+  it "should default the required RubyGems version to >= 1.3.6" do
+    @project.required_rubygems_version.should == '>= 1.3.6'
+  end
+end