named 1.0.0 → 1.1.0

data/README.md

@@ -1,6 +1,53 @@
 # Named
 
-TODO: Write a gem description
+Give anonymous modules and classes names when they are inspected.
+
+[![Build Status](https://secure.travis-ci.org/adamhunter/named.png?branch=master)](http://travis-ci.org/adamhunter/named)
+[![Code Climate](https://codeclimate.com/github/adamhunter/named.png)](https://codeclimate.com/github/adamhunter/named)
+
+## Usage
+
+### Named modules
+
+```ruby
+fancy_module = Named::Module.new('FancyModule') do
+  def module_method
+    puts 'Hello from the module'
+  end
+end
+
+fancy_module.inspect # => "Named::Module:FancyModule:0x7fa9ea9e6178"
+```
+
+### Named classes
+
+```ruby
+# subclasses Array
+fancy_class = Named::Class.new('FancyClass', Array) do
+  def class_method
+    puts 'Hello from the class'
+  end
+end
+
+# Inspection string shows the superclass
+fancy_class.inspect => "Named::Class:Array:FancyClass:0x7fa9ea8aaea8"
+```
+
+### Using them together
+```ruby
+fancy_class.send(:include, fancy_module)
+
+fancy_class.ancestors # => [Named::Class:Array:FancyClass:0x7fa9ea8aaea8,
+                      #     Named::Module:FancyModule:0x7fa9ea9e6178,
+                      #     Named::Class, Named::Naming,
+                      #     Array, Kernel, BasicObject]
+
+instance = fancy_class.new
+
+instance.module_method # => 'Hello from the module'
+instance.class_method  # => 'Hello from the class'
+
+```
 
 ## Installation
 
@@ -16,10 +63,6 @@ Or install it yourself as:
 
     $ gem install named
 
-## Usage
-
-TODO: Write usage instructions here
-
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/lib/named.rb

@@ -2,6 +2,7 @@ module Named
 end
 
 require "named/version"
+require 'named/inspection'
 require 'named/naming'
 require 'named/class'
 require 'named/module'

data/lib/named/class.rb

@@ -1,26 +1,27 @@
 module Named
   module Class
-    include Naming
-
     def self.new(name, superclass = Object, &block)
       ::Class.new(superclass, &block).tap do |klass|
+        klass.extend(self) # adds support for is_a?
         klass.extend(ClassMethods)
-        klass.send(:include, self)
+        klass.send(:include, InstanceMethods)
         klass.name = name
       end
     end
 
     module ClassMethods
-      include Naming
+      include Inspection, Naming
 
       def to_s
         [Named::Class, superclass, name, inspect_object_id].join(':')
       end
     end
 
-    # implementation from: http://stackoverflow.com/a/2818916/4376
-    def to_s
-      "#<#{self.class}:#{inspect_object_id}>".sub(":#{self.class.inspect_object_id}", '')
+    module InstanceMethods
+      include Inspection
+      def to_s
+        "#<#{self.class}:#{inspect_object_id}>".sub(":#{self.class.inspect_object_id}", '')
+      end
     end
   end
 end

data/lib/named/inspection.rb

@@ -0,0 +1,8 @@
+module Named
+  module Inspection
+    # implementation from: http://stackoverflow.com/a/2818916/4376
+    def inspect_object_id
+      "0x%x" % (object_id << 1)
+    end
+  end
+end

data/lib/named/module.rb

@@ -1,6 +1,6 @@
 module Named
   class Module < ::Module
-    include Naming
+    include Inspection, Naming
 
     def initialize(name, &block)
       super(&block)

data/lib/named/naming.rb

@@ -1,9 +1,5 @@
 module Named
   module Naming
     attr_accessor :name
-
-    def inspect_object_id
-      "0x00%x" % (object_id << 1)
-    end
   end
 end

data/lib/named/version.rb

@@ -1,3 +1,3 @@
 module Named
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/named.gemspec

@@ -18,7 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rspec",   "~> 2.13"
+  spec.add_development_dependency "bundler",   "~> 1.3"
+  spec.add_development_dependency "rspec",     "~> 2.13"
+  spec.add_development_dependency "simplecov", "~> 0.7"
   spec.add_development_dependency "rake"
 end

data/spec/named/class_spec.rb

@@ -1,7 +1,73 @@
 require 'spec_helper'
 
 describe Named::Class do
+  let(:subject) { Named::Class.new("Spec Class") { attr_accessor :foo } }
+
   it "is a module" do
     expect(Named::Class).to be_a(Module)
   end
+
+  it "is a Named::Class" do
+    expect(subject).to be_a(Named::Class)
+  end
+
+  describe "class creation" do
+    it "has the provided code block as its body" do
+      expect(subject.new).to respond_to(:foo)
+    end
+  end
+
+  describe "classes" do
+    describe "to_s" do
+      it "starts with Named::Class" do
+        expect(subject.to_s).to start_with 'Named::Class'
+      end
+
+      it "includes the given module name" do
+        expect(subject.to_s).to include("Spec Class")
+      end
+
+      it "ends with the properly formatted object id" do
+        expect(subject.to_s).to end_with(subject.inspect_object_id)
+      end
+    end
+
+    describe "inspect" do
+      it "is the same as to_s" do
+        expect(subject.to_s).to eq subject.inspect
+      end
+    end
+  end
+
+  describe "instances" do
+    let(:instance) { subject.new }
+
+    it "is not a Named::Class" do
+      expect(instance).not_to be_a(Named::Class)
+    end
+
+    it "does not have a name accessor" do
+      expect(instance).not_to respond_to(:name)
+    end
+
+    describe "to_s" do
+      it "starts with Named::Class" do
+        expect(instance.to_s).to start_with '#<Named::Class'
+      end
+
+      it "includes the given module name" do
+        expect(instance.to_s).to include("Spec Class")
+      end
+
+      it "ends with the properly formatted object id" do
+        expect(instance.to_s).to end_with("#{instance.inspect_object_id}>")
+      end
+    end
+
+    describe "inspect" do
+      it "is the same as to_s" do
+        expect(instance.to_s).to eq instance.inspect
+      end
+    end
+  end
 end

data/spec/named/inspection_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Named::Inspection do
+  let(:subject) { Class.new.extend(described_class) }
+
+  it "properly formats object ids" do
+    _, hex_object_id = subject.inspect_object_id.split('x')
+    expect(subject.inspect).to include hex_object_id
+  end
+end

data/spec/named/module_spec.rb

@@ -1,7 +1,38 @@
 require 'spec_helper'
 
 describe Named::Module do
+
+  let(:subject) { Named::Module.new("Spec Module") { attr_accessor :foo } }
+
   it "is a class" do
     expect(Named::Module).to be_a(Class)
   end
+
+  describe "module creation" do
+    before(:each) { subject.extend(subject) }
+
+    it "has the provided code block as its body" do
+      expect(subject).to respond_to(:foo)
+    end
+  end
+
+  describe "to_s" do
+    it "starts with Named::Module" do
+      expect(subject.to_s).to start_with 'Named::Module'
+    end
+
+    it "includes the given module name" do
+      expect(subject.to_s).to include("Spec Module")
+    end
+
+    it "ends with the properly formatted object id" do
+      expect(subject.to_s).to end_with(subject.inspect_object_id)
+    end
+  end
+
+  describe "inspect" do
+    it "is the same as to_s" do
+      expect(subject.to_s).to eq subject.inspect
+    end
+  end
 end

data/spec/named/naming_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Named::Naming do
+  let(:subject) { Class.new.extend(described_class) }
+
+  it "adds a name getter" do
+    expect(subject).to respond_to :name
+  end
+
+  it "adds a name setter" do
+    expect(subject).to respond_to :name=
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,6 @@
 require 'named'
+require 'simplecov'
+SimpleCov.start
 
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: named
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -44,6 +44,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -76,12 +92,15 @@ files:
 - Rakefile
 - lib/named.rb
 - lib/named/class.rb
+- lib/named/inspection.rb
 - lib/named/module.rb
 - lib/named/naming.rb
 - lib/named/version.rb
 - named.gemspec
 - spec/named/class_spec.rb
+- spec/named/inspection_spec.rb
 - spec/named/module_spec.rb
+- spec/named/naming_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/adamhunter/named
 licenses:
@@ -98,7 +117,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2815502534427764522
+      hash: 2605474607335762517
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -107,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2815502534427764522
+      hash: 2605474607335762517
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -117,5 +136,7 @@ summary: Allows providing a name when creating an anonymous module or class usin
   Named::Module.new or Named::Class.new
 test_files:
 - spec/named/class_spec.rb
+- spec/named/inspection_spec.rb
 - spec/named/module_spec.rb
+- spec/named/naming_spec.rb
 - spec/spec_helper.rb