angumine 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzhlNzUxZmRhMzAxYmUxYmM3MzExZWUyY2I5ZjNhM2FiNjU0NGQxMA==
+  data.tar.gz: !binary |-
+    OWQwMzk0OGY0Njc0YWQ2ZmFiY2ExMjAzYTk5YmQ0OWY5NzE2MDQ5Zg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MmIwOTZiZWM0Y2RmMzdiOGE2ZTAwOWIzNTFiNmJlZmQxZDgxZjE3YjQ4MDUz
+    NjRiYTU0OWMzMTM1OTJlYmIwOThlZTNmYjQ2MGU2ZGM2ODYxNzFmMzY5MjZm
+    YzU0YTE1OWExMTVmYTdmMjU0MWQ3ZGFkYzZmNDUwZmY0YjgxZmQ=
+  data.tar.gz: !binary |-
+    ZDdmMzNiNTRjM2EyZWFhYmY0M2Q2MGYyNGEyNWRlMWJhNTQ5Y2FkNWNhYjY2
+    Zjk0OTI3YWE2YWM3YjQxN2FmOWYwOTBmYzZlNDZkM2NhMTYyZTNhNzYxOTcx
+    MjI3ZmY2Njg5M2E5ODkzZDQ3NWU2MjU5OGU5OTY1Y2Q0Nzc1YmM=

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2012 Gary S. Weaver
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+Angumine
+=====
+
+Angumine is a simple command-line utility to parse AngularJS HTML templates for `ng-*` and handlebars (`{{...}}`) references to data that builds a dot-notated tree using loop structures found in the template, i.e. if the template contains:
+
+```html
+{{something.here}}
+<beautifullist ng-class="ngClassesAreIgnored" ng-repeat="project in projects">
+  <documents ng-repeat="paper in project.papers">
+    <docbody ng-show="paper.visible">
+      {{paper.text}}
+      {{another.thing}}
+    </docbody>
+  </documents>
+</beautifullist>
+```
+
+The output would be:
+```
+$ angumine test.html 
+
+---------
+test.html
+---------
+
+something.here
+[projects]project.[project.papers]paper.visible
+[projects]project.[project.papers]paper.text
+another.thing
+```
+
+### Installation
+
+```
+gem install angumine
+```
+
+### Usage
+
+```
+angumine file_or_dir_1 file_or_dir_2 file_or_dir_3
+```
+
+Or
+
+```
+angumine -r file_or_dir_to_search_recursively_1 file_or_dir_to_search_recursively_2
+```
+
+e.g.
+
+```
+angumine -r app/assets/templates/
+```
+
+### License
+
+Copyright (c) 2013 Gary S. Weaver, released under the [MIT license][lic].
+
+[lic]: http://github.com/garysweaver/angumine/blob/master/LICENSE

data/bin/angumine

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'angumine/cli'
+
+begin
+  Angumine::CLI.parse(*ARGV)
+rescue ArgumentError => e
+  puts "#{e.message}"
+end

data/lib/angumine.rb

@@ -0,0 +1,15 @@
+require 'angumine/version'
+require 'nokogiri'
+require 'angumine/cli'
+require 'angumine/sax_parser'
+
+module Angumine
+  class << self
+    def parse(file_contents)
+      sax_parser = Angumine::SaxParser.new
+      parser = Nokogiri::HTML::SAX::Parser.new(sax_parser)
+      parser.parse(file_contents)
+      sax_parser.mined_data
+    end
+  end
+end

data/lib/angumine/cli.rb

@@ -0,0 +1,74 @@
+require 'angumine'
+
+# angumine
+#
+# Finds references to models in AngularJS and attempts to keep track of ng-repeat, etc. to build a tree.
+# This may be helpful if you are trying to determine the JSON views required.
+#
+# Mines Angular Templates for model information.
+module Angumine
+  class CLI
+
+    def self.fail
+      raise ArgumentError.new("Usage: angumine [-r] path_or_file1 [path_or_file2 [...]]\n\n  -r - recursively search specified path(s)")
+    end
+
+    def self.parse(*args)
+      fail if args.length == 0
+
+      recursive = args.include?('-r') ? !!args.delete('-r') : false
+      fail if args.any? {|a|a.start_with?('-')}
+
+      pathnames = []
+      if recursive
+        # recursively list all files under specified paths
+        require 'find'
+        args.each do |dir_or_file_path|
+          if FileTest.directory?(dir_or_file_path)
+            Find.find(dir_or_file_path) do |path|
+              if FileTest.directory?(path)
+                # ignore dot directories
+                if File.basename(path)[0] == ?.
+                  Find.prune
+                else
+                  next
+                end
+              else
+                pathnames << path
+              end
+            end
+          else
+            pathnames << path
+          end
+        end
+      else
+        args.each do |dir_or_file_path|
+          if FileTest.directory?(dir_or_file_path)
+            puts "Note: non-recursively listing directory '#{dir_or_file_path}'. For recursive search, use -r.\n\n"
+            pathnames += Dir.glob(dir_or_file_path).reject {|path| FileTest.directory?(path) || File.basename(path)[0] == ?.}
+          else
+            pathnames << dir_or_file_path
+          end
+        end
+      end
+
+      if pathnames.length == 0
+        puts "No templates found."
+        return
+      end
+
+      pathnames.each do |pathname|
+        puts
+        puts '-' * pathname.length
+        puts pathname
+        puts '-' * pathname.length
+        puts
+        tree_path = []
+        File.open(pathname, 'r') do |file|
+          Angumine.parse(IO.read(file)).each {|s| puts s}
+        end
+      end
+    end
+  end
+end
+

data/lib/angumine/sax_parser.rb

@@ -0,0 +1,70 @@
+require 'nokogiri'
+
+module Angumine
+  class SaxParser < Nokogiri::XML::SAX::Document
+  
+    attr_accessor :treepath, :name_to_branch, :mined_data
+
+    def initialize(*args)
+      self.treepath ||= []
+      self.name_to_branch ||= {}
+      self.mined_data = []
+    end
+
+    def am_clean_and_prefix_path(s)
+      return unless s
+      am_prefix_path(am_clean(s))
+    end
+
+    def am_clean(s)
+      s = s.join if s.is_a?(Array)
+      s = s.strip
+    end
+
+    def am_prefix_path(s)
+      return s if self.name_to_branch.length == 0
+      orig = s
+      
+      ending = ''
+      non_var_name_index = s.index(/[\ \|]/)
+      s, ending = *[s[0,non_var_name_index], s[non_var_name_index,s.length]] if non_var_name_index
+      non_var_name_index = s.index('.')
+      s, rest_of_val = *[s[0,non_var_name_index], s[non_var_name_index,s.length]] if non_var_name_index    
+
+      tree_branch_index = self.name_to_branch[s]
+      if tree_branch_index
+        "#{self.treepath[0..tree_branch_index].collect{|i|i[0]}.join('.')}#{rest_of_val}#{ending}"
+      else
+        orig
+      end
+    end
+
+    def start_element name, attributes = []
+      if self.treepath.last
+        self.treepath.last[1] += 1 if self.treepath.last[1] > 0
+      end
+      Hash[attributes].each do |k,v|
+        next unless v
+        v = am_clean(v)
+        if k.start_with?('ng-') && k != 'ng-class' && v
+          if v.index(' in ')
+            loop_data = v.split(' in ')
+            arr = ["[#{loop_data[1]}]#{loop_data[0]}", 1]
+            self.name_to_branch[loop_data[0]] = self.treepath.length # which currently is the next index
+            self.treepath << arr
+          else
+            self.mined_data << "#{am_clean_and_prefix_path(v)}"
+          end
+        end
+      end
+    end
+
+    def characters(s)
+      s.scan(/{{([^}]*)}}/).each {|v|self.mined_data << "#{am_clean_and_prefix_path(v)}"}
+    end
+
+    def end_element name
+      self.treepath.last[1] -= 1 if self.treepath.last && self.treepath.last[1] > 0
+    end
+  end
+end

data/lib/angumine/version.rb

@@ -0,0 +1,3 @@
+module Angumine
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: angumine
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gary S. Weaver
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Angumine makes it easier to parse one or more templates (or parse recursively)
+  for references to data in ng-* attributes and within handlebars
+email:
+- garysweaver@gmail.com
+executables:
+- angumine
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/angumine/cli.rb
+- lib/angumine/sax_parser.rb
+- lib/angumine/version.rb
+- lib/angumine.rb
+- bin/angumine
+- README.md
+- LICENSE
+homepage: https://github.com/garysweaver/angumine
+licenses:
+- MIT
+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.0.6
+signing_key: 
+specification_version: 4
+summary: Mines AngularJS templates for data references
+test_files: []