bringhurst 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 96c05ab54df1c8c8555a51479623a793f8cac7e8
+  data.tar.gz: ed4d3decf22d8facb79117b39bb55895b44dd4dc
+SHA512:
+  metadata.gz: 3167a6762ce23b31513fec0b16a2a75d72b3cf383f5ded948542fff3bcefbbb7f4696488dc54a4852dab2ed08f86348b6cc1a00d76c94bbee2732cdec73dc288
+  data.tar.gz: adcb0a40ac1c84f942c14a9449e7eeff0cd4eba7f3f4b599fd3ab94fa15f93d4921c238fb077d912f3335981a649ed7b5d868e7b2927d72059aed813a457a7ee

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in bringhurst.gemspec
+gemspec

data/README.md

@@ -0,0 +1,129 @@
+# Bringhurst
+
+Bringhurst watches you run your methods, infers their types, and formats the
+results. It does this by aliasing each method in a user-defined collection of
+classes and noting the types of their arguments and results.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "bringhurst"
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install bringhurst
+```
+
+## Usage
+
+Once Bringhurst is installed, you'll need to tell it which classes to observe
+and when to display the results. I recommend setting it up in your `spec_helper`
+by doing something like:
+
+```ruby
+require "bringhurst"
+
+RSpec.configure do |config|
+  # ...
+  def observer
+    Bringhurst::TypeObserver.instance
+  end
+
+  config.before(:suite) do
+    observer.observe_class(Gitsh::CapturingEnvironment)
+    observer.observe_class(Gitsh::Completer)
+    observer.observe_class(Gitsh::Environment)
+  end
+
+  config.after(:suite) do
+    puts Bringhurst::Formatter.new(observer.method_calls)
+  end
+  # ...
+end
+```
+
+Next, run the tests:
+
+```
+$ rspec
+```
+
+And see the results:
+
+```
+...........................................
+Observed Type Signatures
+========================
+Gitsh::CapturingEnvironment#captured_output: String
+Gitsh::CapturingEnvironment#output_stream: IO
+Gitsh::Completer#call: String -> Array
+Gitsh::Environment#[]=: String -> String -> String
+Gitsh::Environment#[]=: Symbol -> String -> String
+Gitsh::Environment#config_variables: Hash
+Gitsh::Environment#error_stream: StringIO
+Gitsh::Environment#fetch: String -> NilClass
+Gitsh::Environment#fetch: String -> String
+Gitsh::Environment#fetch: String -> TrueClass -> String
+Gitsh::Environment#fetch: Symbol -> String
+Gitsh::Environment#git_aliases: Array
+Gitsh::Environment#git_command: FalseClass -> String
+Gitsh::Environment#git_command: String
+Gitsh::Environment#git_command: TrueClass -> String
+Gitsh::Environment#git_command=: String -> String
+Gitsh::Environment#git_commands: RSpec::Mocks::Double
+Gitsh::Environment#input_stream: IO
+Gitsh::Environment#input_stream: RSpec::Mocks::Double
+Gitsh::Environment#output_stream: IO
+Gitsh::Environment#output_stream: RSpec::Mocks::Double
+Gitsh::Environment#output_stream: StringIO
+Gitsh::Environment#print: String -> NilClass
+Gitsh::Environment#puts: String -> NilClass
+Gitsh::Environment#puts_error: String -> NilClass
+Gitsh::Environment#readline_version: String
+Gitsh::Environment#repo_config_color: String -> String -> RSpec::Mocks::Double
+Gitsh::Environment#repo_current_head: RSpec::Mocks::Double
+Gitsh::Environment#repo_has_modified_files?: RSpec::Mocks::Double
+Gitsh::Environment#repo_has_untracked_files?: RSpec::Mocks::Double
+Gitsh::Environment#repo_heads: RSpec::Mocks::Double
+Gitsh::Environment#repo_initialized?: RSpec::Mocks::Double
+Gitsh::Environment#tty?: FalseClass
+Gitsh::Environment#tty?: TrueClass
+```
+
+(I'm hijacking the lovely [gitsh](https://github.com/thoughtbot/gitsh) here for
+my examples.)
+
+You can use it in places other than tests, but I wouldn't recommend it -- it'll
+definitely adversely affect performance.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/hrs/bringhurst.
+
+## Weird name.
+
+"Bringhurst" references one of my favorite
+[observers of types](https://en.wikipedia.org/wiki/The_Elements_of_Typographic_Style).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bringhurst"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bringhurst.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bringhurst/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bringhurst"
+  spec.version       = Bringhurst::VERSION
+  spec.authors       = ["Harry R. Schwartz"]
+  spec.email         = ["hello@harryrschwartz.com"]
+
+  spec.summary       = "Infer your methods' types and generate signatures."
+  spec.homepage      = "https://github.com/hrs/bringhurst"
+  spec.license       = "GPL-3.0"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/bringhurst.rb

@@ -0,0 +1,7 @@
+require "bringhurst/version"
+require "bringhurst/formatter"
+require "bringhurst/type_observer"
+require "bringhurst/type_signature"
+
+module Bringhurst
+end

data/lib/bringhurst/formatter.rb

@@ -0,0 +1,18 @@
+module Bringhurst
+  class Formatter
+    def initialize(signatures)
+      @signatures = signatures
+    end
+
+    def to_s
+      "\n" +
+        "Observed Type Signatures\n" +
+        "========================\n" +
+        signatures.map(&:to_s).uniq.sort.join("\n")
+    end
+
+    private
+
+    attr_reader :signatures
+  end
+end

data/lib/bringhurst/type_observer.rb

@@ -0,0 +1,102 @@
+require "securerandom"
+require "singleton"
+require_relative "type_signature"
+
+module Bringhurst
+  class TypeObserver
+    include Singleton
+
+    attr_reader :method_calls
+
+    def initialize
+      @method_calls = []
+    end
+
+    def observe_class(klass)
+      wrap_instance_methods_of(klass)
+      wrap_class_methods_of(klass)
+    end
+
+    def register_call(signature)
+      @method_calls << signature
+    end
+
+    private
+
+    def wrap_instance_methods_of(klass)
+      instance_methods_of(klass).each do |method_name|
+        wrap_instance_method(klass, method_name)
+      end
+    end
+
+    def wrap_class_methods_of(klass)
+      class_methods_of(klass).each do |method_name|
+        wrap_class_method(klass, method_name)
+      end
+    end
+
+    def wrap_instance_method(klass, method_name)
+      aliased_method_name = aliased_method_name_for(method_name)
+
+      klass.class_eval do
+        alias_method(aliased_method_name, method_name)
+
+        define_method(method_name) do |*args, &block|
+          result = public_send(aliased_method_name, *args, &block)
+
+          Bringhurst::TypeObserver.instance.register_call(
+            Bringhurst::TypeSignature.new(
+              klass: klass,
+              method: method_name,
+              method_kind: :instance,
+              arguments: args.map(&:class),
+              result: result.class,
+            ),
+          )
+
+          result
+        end
+      end
+    end
+
+    def wrap_class_method(klass, method_name)
+      aliased_method_name = aliased_method_name_for(method_name)
+
+      klass.class_eval do
+        singleton_class.send(
+          :alias_method,
+          aliased_method_name,
+          method_name,
+        )
+
+        define_singleton_method(method_name) do |*args, &block|
+          result = public_send(aliased_method_name, *args, &block)
+
+          Bringhurst::TypeObserver.instance.register_call(
+            Bringhurst::TypeSignature.new(
+              klass: klass,
+              method: method_name,
+              method_kind: :class,
+              arguments: args.map(&:class),
+              result: result.class,
+            ),
+          )
+
+          result
+        end
+      end
+    end
+
+    def instance_methods_of(klass)
+      klass.instance_methods(false)
+    end
+
+    def class_methods_of(klass)
+      klass.methods(false)
+    end
+
+    def aliased_method_name_for(method_name)
+      "#{ method_name }_#{ SecureRandom.uuid }"
+    end
+  end
+end

data/lib/bringhurst/type_signature.rb

@@ -0,0 +1,36 @@
+module Bringhurst
+  class TypeSignature
+    attr_reader :klass, :method, :method_kind, :arguments, :result
+
+    def initialize(klass:, method:, method_kind:, arguments:, result:)
+      @klass = klass
+      @method = method
+      @method_kind = method_kind
+      @arguments = arguments
+      @result = result
+    end
+
+    def ==(other)
+      self.class == other.class &&
+        klass == other.klass &&
+        method == other.method &&
+        method_kind == other.method_kind &&
+        arguments == other.arguments &&
+        result == other.result
+    end
+
+    def to_s
+      "#{ method_name }: #{ (arguments + [result]).map(&:to_s).join(" -> ") }"
+    end
+
+    private
+
+    def method_name
+      if method_kind == :instance
+        "#{ klass }##{ method }"
+      elsif method_kind == :class
+        "#{ klass }.#{ method }"
+      end
+    end
+  end
+end

data/lib/bringhurst/version.rb

@@ -0,0 +1,3 @@
+module Bringhurst
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: bringhurst
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Harry R. Schwartz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- hello@harryrschwartz.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bringhurst.gemspec
+- lib/bringhurst.rb
+- lib/bringhurst/formatter.rb
+- lib/bringhurst/type_observer.rb
+- lib/bringhurst/type_signature.rb
+- lib/bringhurst/version.rb
+homepage: https://github.com/hrs/bringhurst
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Infer your methods' types and generate signatures.
+test_files: []