dissect 0.1.0pre → 0.1.1pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1b18e052c8694d0856f43ab81a15c13201987cf
-  data.tar.gz: eb9c6ed81637ef765a0778ef0c41e90237ec303f
+  metadata.gz: d7ead41a217cfd49b5a6ecb1ab7e8de0fa05ab50
+  data.tar.gz: c5ae819d6d09de484058f0aa659cb1300f69fb5b
 SHA512:
-  metadata.gz: 02ec23c0f9a2751feed840bb821a8561dc7ea9008d14b2a129cdd493a0be595fc8680d8ce43ed495133fe875d124902be647f3b0bf6e233bc679b5c2f9a6a8de
-  data.tar.gz: a77c6b7d0ba90d1c2d33e8e421d8eb3a60623ce69b6e8ec2ea915714a758bd3e09182477b0e07b0c4638b0c65061c7f72131391d084a2b05a9f1619d5d00a6c0
+  metadata.gz: b65b43998c97673c197bdc9a597786b1358afe47015f24963c80a65a69764c2a6bd3528e0e7c11c0132fa8dcf604977fb21f7c6e3ea0832a96c5519f981f3591
+  data.tar.gz: 30499cd34de4c31c574139ed84774a08fac0904a11d90bdb59217540847c1ddaa0f5477a0b81308bd11b883acddbd458c961ba18c57429e2100308e60e2c1be4

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/README.md

@@ -1,14 +1,23 @@
-[travis]: https://travis-ci.org/blacktangent/dissect
+[travis]: https://travis-ci.org/olejrosendahl/dissect
+[codeclimate]: https://codeclimate.com/github/olejrosendahl/dissect
+[coveralls]: https://coveralls.io/r/olejrosendahl/dissect
+[rubygems]: https://rubygems.org/gems/dissect
 
 # Dissect
 
-[![Build Status](https://travis-ci.org/blacktangent/dissect.svg?branch=master)][travis]
+[![Build Status](https://travis-ci.org/olejrosendahl/dissect.svg?branch=master)][travis]
+[![Code Climate](https://codeclimate.com/github/olejrosendahl/dissect/badges/gpa.svg)][codeclimate]
+[![Test Coverage](http://img.shields.io/coveralls/olejrosendahl/dissect/master.svg)][coveralls]
+[![Gem Version](http://img.shields.io/gem/v/dissect.svg)][rubygems]
 
-Problem: Known Gems have has good or bad documentation, examples or
-Wikies, but what often lacks is examples of the features used in the wild.
+*EXPERIMENTAL*
 
-Solution: Find Open Source projects for the Gems to see how the
-libraries API's are being used in the wild to find good examples.
+Problem: Libraries are often well documented, but what often lacks to
+get started is to see examples of their features used in the wild.
+
+Solution: Find Open Source projects on Github where the libraries are
+used. Learn their API's and see how other programmers use them and
+explore possibilities.
 
 ## Installation
 
@@ -28,19 +37,23 @@ Or install it yourself as:
 
 ## API
 
-	# search organization for given gem name
-	code_search(gem_name, organization, options = {})
+```ruby
+# search organization for given library name
+find(organization, name)
+```
 
 ## Usage
 
-	dissect = Dissect::Client.new
-	findings = dissect.code_search("rails", "thoughtbot", "ruby")
-	findings.each do |f|
-    puts f.name
-    puts f.path
-    puts f.html_url
-    puts f.repository_name
-	end
+```ruby
+dissect = Dissect::Finders::GemFinder.new
+findings = dissect.find("thoughtbot", "devise")
+findings.each do |f|
+  puts f.name
+  puts f.path
+  puts f.html_url
+  puts f.repository_name
+end
+```
 
 ## Development
  

data/dissect.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "vcr"
   spec.add_development_dependency "webmock"
+  spec.add_development_dependency "coveralls"
 end

data/lib/dissect.rb

@@ -1,5 +1,6 @@
 require "dissect/version"
-require "dissect/client"
 require "dissect/formatters/json"
 require "dissect/models/finding"
+require "dissect/finders/base_finder"
+require "dissect/finders/gem_finder"
 require "octokit"

data/lib/dissect/finders/base_finder.rb

@@ -0,0 +1,29 @@
+module Dissect
+  module Finders
+    class BaseFinder
+
+      def initialize
+        @connection = Octokit::Client.new
+      end
+
+      def find(organization, name, language)
+        findings = []
+        patterns.each do |pattern|
+          query = "#{sprintf(pattern["pattern"], name)} filename:#{pattern["filename"]} path:#{pattern["path"]} user:#{organization} language:#{language}"
+          result = @connection.get("/search/code", q: query)
+          result[:items].each do |item|
+            findings << Models::Finding.new(item, pattern["description"])
+          end
+        end
+        findings
+      end
+
+      private
+
+      def patterns
+        JSON.parse(File.read("#{File.dirname(__FILE__)}/../../../patterns.json"))
+      end
+
+    end
+  end
+end

data/lib/dissect/finders/gem_finder.rb

@@ -0,0 +1,11 @@
+module Dissect
+  module Finders
+    class GemFinder < BaseFinder
+
+      def find(organization, name)
+        super(organization, name, "ruby")
+      end
+
+    end
+  end
+end

data/lib/dissect/models/finding.rb

@@ -1,10 +1,10 @@
 module Dissect
   module Models
     class Finding
-      attr_accessor :item
+      attr_accessor :item, :description
 
-      def initialize(item)
-        @item = item
+      def initialize(item, description)
+        @item, @description = item, description
       end
 
       def name

data/lib/dissect/version.rb

@@ -1,3 +1,3 @@
 module Dissect
-  VERSION = "0.1.0pre"
+  VERSION = "0.1.1pre"
 end

data/patterns.json

@@ -0,0 +1,8 @@
+[
+  {
+    "pattern": "gem %s",
+    "filename": "Gemfile",
+    "path": "/",
+    "description": "Gemfile"
+  }
+]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dissect
 version: !ruby/object:Gem::Version
-  version: 0.1.0pre
+  version: 0.1.1pre
 platform: ruby
 authors:
 - Ole J. Rosendahl
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-26 00:00:00.000000000 Z
+date: 2015-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Simple wrapper around Octokit.rb's code search to find Gems in Gemfiles
 email:
 - ole.johnny.rosendahl@gmail.com
@@ -101,6 +115,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -114,11 +129,13 @@ files:
 - bin/setup
 - dissect.gemspec
 - lib/dissect.rb
-- lib/dissect/client.rb
+- lib/dissect/finders/base_finder.rb
+- lib/dissect/finders/gem_finder.rb
 - lib/dissect/formatters/console.rb
 - lib/dissect/formatters/json.rb
 - lib/dissect/models/finding.rb
 - lib/dissect/version.rb
+- patterns.json
 homepage: https://github.com/olejrosendahl/dissect
 licenses:
 - MIT

data/lib/dissect/client.rb

@@ -1,31 +0,0 @@
-module Dissect
-  class Client
-
-    PATTERNS = [
-      "gem '%s' filename:Gemfile path:/",
-      "gem \"%s\" filename:Gemfile path:/",
-    ]
-
-    def initialize
-      @connection = Octokit::Client.new
-    end
-
-    def code_search(gem, organisation, language)
-      findings = []
-      PATTERNS.each do |pattern|
-        result = @connection.get("/search/code", q: query_string(pattern, gem, organisation, language))
-        result[:items].each do |item|
-          findings << Models::Finding.new(item)
-        end
-      end
-      findings
-    end
-
-    private
-
-    def query_string(pattern, gem, user, language)
-      sprintf(pattern, gem) + " user:#{user} language:#{language}"
-    end
-
-  end
-end