active_resource_inspector 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1fbc1df0aef73d8397d4a7122b8e3c3eae314573
-  data.tar.gz: 1b274db93071e7ac9e2e56c55d99e7eb99170a45
+  metadata.gz: 263c0bb7b2ba44879188cac903f0736c11f160ea
+  data.tar.gz: 25a87e4e343ebe709b7f3b1648ce493937d8c4c4
 SHA512:
-  metadata.gz: 3d69b4798b70f8bd49872484dc6ff2f535c614ca0ba9cd169e782a07bd6b88a4c5e05c31d15fa49f374fb192afa718f376c55927caa318cb03d4df5d84f9168b
-  data.tar.gz: e182e8b0fcc257128075678adbba2fdc5d3483c2f9c6cd1f45f66dc88e7ce107d18d809304ad626dbd9f8535095c3baecbe1022cfd2a9dccc5dc2ed2cf143ac2
+  metadata.gz: 48cb5dd0b57da36e33850cd0a239aa21db49e572c60f574cbb2f93faea034f3c606ea4f8263899295295045d586aa04f22d0c9af554b505906071375e4abe302
+  data.tar.gz: bca5207196a38f04d32679079974e86daf8a3377a50910bd0235584a978765236a93e1f498e8f83204f612e1b66661f1047f8862c86f883ea22ad3777bb95936

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem

data/README.md

@@ -1,39 +1,63 @@
-# ActiveResourceInspector
+ActiveResource Inspector
+========================
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/active_resource_inspector`. To experiment with that code, run `bin/console` for an interactive prompt.
+The gem provides ability to inspect ActiveResource files of any ruby project.
 
-TODO: Delete this and the text above, and describe your gem
+Using the `Rake` task, it prints results in format much like Rails's rake route does, but here it grouped by host and authentication type.
 
-## Installation
+Case for Rails project:
+-----------------------
 
-Add this line to your application's Gemfile:
+For example in your Rails project you could have ActiveResource model like so:
 
-```ruby
-gem 'active_resource_inspector'
 ```
+class Inventory < ActiveResource::Base
+  include ActiveResource::Singleton
+  self.site = 'http://example.com:3000'
+  self.prefix = '/products/:product_id/'
+end
+```
+
+and you type within project folder:
 
-And then execute:
+```
+rake resources:list
+```
 
-    $ bundle
+you will get:
 
-Or install it yourself as:
+```
+~/you_rails_project$ rake resources:list
+Location: /Users/tsyren/code/book_store/app/models
 
-    $ gem install active_resource_inspector
+http://37s.sunrise.i:3000 (no auth)
+                                    /products/:product_id/inventories.json
+```
 
-## Usage
+Case for non-Rails project:
+---------------------------
 
-TODO: Write usage instructions here
+For non-Rails project you need to pass the path manually, for example you stored your active resource files in `./app/resources` folder then:
 
-## Development
+```
+rake resources:list["./app/resources"]
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+and the result expected the same as above example.
 
-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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Installation
+------------
+
+```
+gem 'active_resource_inspector', group: :development
+```
+
+or
+
+```
+gem install active_resource_inspector
+```
 
-## Contributing
+note: aims for development usage only.
 
-1. Fork it ( https://github.com/[my-github-username]/active_resource_inspector/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+Give try and drop me feedback.

data/active_resource_inspector.gemspec

@@ -19,6 +19,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency 'activesupport', '>= 4.0.0'
+
   spec.add_development_dependency "bundler", "~> 1.9"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "activeresource", '~> 4.0', '>= 4.0.0'
 end

data/lib/active_resource_inspector.rb

@@ -1,63 +1,48 @@
+require 'active_support/core_ext/string/inflections'
 require "active_resource_inspector/version"
 require 'active_resource_inspector/railtie' if defined?(Rails::Railtie)
 
 module ActiveResourceInspector
-  def self.run(type = nil)
-    Base.new.send(type || :short_print)
-  end
-
   class Base
-    def initialize
-      @dirname = File.join(Rails.root,'app', 'models')
-      models = Dir[File.join(Rails.root,'app', 'models', '**/*.rb')].select{|res| res.match(/concerns/).nil? }
-      filtered_models = models.select do |res|
-        filename = File.basename(res, '.rb')
-        next if filename.downcase.match(/abstract/)
+    attr_reader :resources
+    attr_accessor :dirname
 
+    def resources
+      @resources ||= files.map do |file|
+        filename = file.split(dirname).last.gsub('.rb', '')
         klass = filename.camelize.constantize
-        ActiveResource::Base == klass.superclass
-      end
-      @resources = filtered_models.sort.map do |res|
-        dir, _ = File.split(res)
-        filename = File.basename(res, '.rb')
-        basedir = dir.split('/').last
-        if  'models' == basedir
-          filename.camelize.constantize
+        next if klass.class == Module
+        if ActiveResource::Base == klass.superclass && klass.site.present?
+          klass
         else
-          "#{basedir}/#{filename}".camelize.constantize
+          next
         end
-      end
+      end.compact
     end
 
-    def short_print
-      defaul_print
+    def files
+      Dir[File.join(dirname, '**/*.rb')]
     end
 
-    def detailed_print
-      defaul_print do |res|
-        ["\t"*5, res.prefix_source, res.collection_name, res.format_extension, " (", res, ") \n\n"].join('')
-      end
+    def self.print(dirpath)
+      factory(dirpath).defaul_print
     end
 
-    def example_print
-      # TO-DO:
-      # set random numbers
-      # /api/v1/shops/12/publishers/4.json
+    def self.detailed_print
+      factory(dirpath).defaul_print do |res|
+        ["\t"*5, res.prefix_source, res.collection_name, res.format_extension, " (", res, ") \n\n"].join('')
+      end
     end
 
-    private
-
     def defaul_print(&block)
-      puts "\nActiveResource Introspection"
-      puts "\nPrint ActiveResource entity's paths grouped by endpoint & auth type."
-      puts "\nLocation: #{@dirname}"
+      puts "Location: #{dirname}"
       puts "\n"
-      @resources.group_by{|e| e.site.to_s }.each do |endpoint, rs|
+      resources.group_by{|e| e.site.to_s }.each do |endpoint, rs|
         rs.group_by{|e| e.auth_type }.each do |auth_type, rs2|
           if auth_type.nil?
-            puts "#{endpoint} #{rs2[0].headers.empty? ? '(no auth)' : 'via '+rs2[0].headers.to_s }"
+            puts "#{endpoint} #{rs2[0].headers.empty? ? '(no auth)' : 'with headers auth '+rs2[0].headers.to_s }"
           else
-            puts "#{endpoint} via #{auth_type.capitalize}"
+            puts "#{endpoint} wiht auth #{auth_type.capitalize}"
           end
           t = rs2.map do |res|
             if block_given?
@@ -68,7 +53,18 @@ module ActiveResourceInspector
           end
           puts t.sort
         end
-        puts '-'*120
+      end
+    end
+
+    private
+
+    def self.factory(dirname)
+      Base.new.tap do |obj|
+        if defined?(Rails::Railtie)
+          obj.dirname = File.join(Rails.root,'app', 'models')
+        else
+          obj.dirname = dirname || '.'
+        end
       end
     end
   end

data/lib/active_resource_inspector/version.rb

@@ -1,3 +1,3 @@
 module ActiveResourceInspector
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/tasks/resources.rake

@@ -2,11 +2,11 @@ require 'active_resource_inspector'
 
 namespace :resources do
   desc "Print ActiveResource entity's paths grouped by endpoint & auth type."
-  task list: :environment do
-    ActiveResourceInspector.run
+  task :list, [:dirname] => :environment do |t, args|
+    ActiveResourceInspector::Base.print(args[:dirname])
   end
-  task detailed_list: :environment do
-    ActiveResourceInspector.run(:detailed_print)
+  task :detailed_list, [:dirname] => :environment do |t, args|
+    ActiveResourceInspector::Base.detailed_print(args[:dirname])
   end
 
   task :default => [:list]

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: active_resource_inspector
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tsyren Ochirov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-27 00:00:00.000000000 Z
+date: 2015-10-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
 description: Allows you to inpsect your project's ActiveResource entities.
 email:
 - nsu1team@gmail.com
@@ -53,6 +87,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- active_resource_inspector-0.1.0.gem
 - active_resource_inspector.gemspec
 - bin/console
 - bin/setup