ngannotate-rails 0.15.4.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 803c3f028160ddb16f237bde0767253166634f9d
-  data.tar.gz: 39f5bff0e5db3f5ee4b28938411c8dba6da5e4b5
+  metadata.gz: eac5144784fb8fa889cb253acee99066f1f1d5a6
+  data.tar.gz: 67c565e93929dbdd1610e1cd8d8a2703a9c64e0d
 SHA512:
-  metadata.gz: ce2eea9455191842a3d04f6653d4711b0972336a00cfa24c1f637d936b560bd44a4b5b71eb257ce57f9feec9e7f29da9de8518a8b67a9c874c65082b5fb7889a
-  data.tar.gz: 350ee5ef46ae826c1158bb469fdff542cf9062b742de27e1ec443c79d9d19ed65d59ef9721b8f1ec5fc17b93164023eb15687dc223cab87fec768f1e2e071e7e
+  metadata.gz: 85a5293de6c2b712eb1867156f57b3838196659a6f5cd94797363aa13dd11cb7cde5b295b5257b68abc27a5df467f7548edad1a34c3ea1542075f21dddf143da
+  data.tar.gz: 98d464f59d5b05ac2db869491166a36cc2ed369a8da6dccfc16aa685836497e4eb265be8f8c67768ef0723c3203b94d19641fbfa710c70d303fac3ac77263303

data/README.md

@@ -21,31 +21,69 @@ Usage
 
 By default ng-annotate processing is disabled in development and test environments. Processing, however, can be enforced by specifying NG_FORCE=true option.
 
+### Environment options
 
-Options available as environment variables:
+- NG_REGEXP
+  * regexp passed to ng-annoate
+  * see ng-annotate documentation
+- NG_OPT
+  * comma separate list of "opt=value" key pairs passed as options to ng-annotate
+  * see ng-annotate documentation
+- NG_FORCE
+  * force ng-annoate processing in development/test environment
 
-    NG_REGEXP     - regexp passed to ng-annoate
-                    see ng-annotate documentation
-    NG_OPT        - comma separate list of "opt=value" key pairs passed as options to ng-annotate
-                    see ng-annotate documentation
-    NG_FORCE=true - force ng-annoate processing in development/test environment
+For example,
 
-You can also define when ng-annotate should process with the `process` option to the environment configuration
+    # Test assets compile in rails development environment
+    # (assuming config/environments/development.rb is adjusted approriately)
+
+    # with rails 3.2
+    NG_FORCE=true RAILS_ENV=development bundle exec rake assets:clean assets:precompile
+
+    # with rails 4.1
+    NG_FORCE=true RAILS_ENV=development bundle exec rake assets:clobber assets:precompile
+
+
+### Rails configuration options
+
+Defined in "config.ng_annotate"
+
+- process
+  * Is annotation processing done for current environment (NG_FORCE=true takes precedence over this)
+  * default: true for production, false for development and test
+- options
+  * Options for ngannotate (NG_OPT and NG_REGEXP env variables take precedence over this)
+  * default: {}
+- paths
+  * Asset paths, which are handled. Paths in ignore_paths override this setting
+    Values can be [String | Regexp | Proc] instances
+  * default: [/.*/]
+- ignore_paths
+  * List of asset paths, which are ignored from ngannotate processing.
+    Values can be [String | Regexp | Proc] instances
+  * default: ['/vendor/']
+
+For example,
 
 config/environments/development.rb
 
     Rails.application.configure do
     ...
         config.ng_annotate.process = true
+        config.ng_annotate.options = {
+          key1: 'value',
+          regexp: '...',
+        }
+        config.ng_annotate.paths = [
+          Rails.root.to_s,
+        ]
+        config.ng_annotate.ignore_paths = [
+          '/vendor/',
+          '/some/path/'
+        ]
     ...
     end
 
-Examples,
-
-    # Test assets compile in rails development environment
-    # (assuming config/environments/development.rb is adjusted approriately)
-    NG_FORCE=true RAILS_ENV=development bundle exec rake assets:clean assets:precompile
-
 
 Testing assets locally
 ----------------------
@@ -76,18 +114,23 @@ precompile & start server
 Versioning
 ----------
 
-The ngannotate-rails version number mirrors the version number for the version of ng-annotate that is bundled with it.
-For minor patch releases, when ng-annotate version is not changing, 4th digit is used (For example, "0.9.6.1").
-Every released version is tagged with tag "v[VERSION]".
+Originally version numbering of this gem followed ng-annoate. However, in order to improve
+handling of possibly compatibility breaking fixes and improvements, version schema is now
+separated from ng-annotate. Instead of matching versions, changelog in
+[wiki](https://github.com/kikonen/ngannotate-rails/wiki) will indicate which is currently matching
+ng-annotate version.
+
+Every released version is tagged with tag "vX.Y.Z".
 
 Release Process
 ---------------
 
-For ngannotate update:
+For ngannotate update (or any other improvements/fixes):
 
 ```bash
 git checkout master
 git pull
+# if ngannotate update
 rake ngannotate:build
 git citool
 # check that result makes sense and if so,
@@ -99,11 +142,6 @@ gem build ngannotate-rails.gemspec
 gem push ngannotate-rails-X.Y.Z.gems
 ```
 
-For internal fixes:
-
-Similar except no ngannotate:build and new version is previous plus fourth digit for patch level (see Versioning).
-
-
 Help
 ----
 

data/lib/ngannotate/processor.rb

@@ -1,57 +1,17 @@
 require 'execjs'
 require 'sprockets/processor'
+require_relative 'processor_common'
 
 module Ngannotate
   class Processor < Sprockets::Processor
-    def self.name
-      'Ngannotate::Processor'
-    end
-
-    def prepare
-      return if skip
-      ngannotate_source = File.open(File.join(File.dirname(__FILE__), '../../vendor/ngannotate.js')).read
-      @context = ExecJS.compile "window = {};" + ngannotate_source
-    end
-
-    #
-    # To allow testing assets compile in development environment
-    #
-    # To explicitly force assets compile in development environment
-    #  NG_FORCE=true RAILS_ENV=development bundle exec rake assets:clean assets:precompile
-    # or add to environments/development.rb
-    #  config.ng_annotate.process = true
-    #
-    def force
-      ENV['NG_FORCE'] == 'true'
-    end
-
-    #
-    # Skip processing in environments where it does not make sense.
-    # Override by NG_FORCE=true env variable
-    #
-    def skip
-      !force && !::Rails.configuration.ng_annotate.process
-    end
+    include ProcessorCommon
 
     def evaluate(context, locals)
-      return data if skip
-
-      opt = { add: true }.merge!(parse_opt)
-      r = @context.call 'window.annotate', data, opt
-      r['src']
-    end
-
-    def parse_opt
-      opt = {}
-      opt_str = ENV['NG_OPT']
-      if opt_str
-        opt = Hash[opt_str.split(',').map { |e| e.split('=') }]
-        opt.symbolize_keys!
-      end
-      if ENV['NG_REGEXP']
-        opt[:regexp] = ENV['NG_REGEXP']
-      end
-      opt
+      input = {
+        filename: @file,
+        data: data,
+      }
+      process_data(input)
     end
   end
 end

data/lib/ngannotate/processor3.rb

@@ -1,65 +1,20 @@
 require 'execjs'
+require_relative 'processor_common'
 
 module Ngannotate
   class Processor
+    include ProcessorCommon
+
     def self.instance
       @instance ||= new
     end
 
-    def self.name
-      'Ngannotate::Processor'
-    end
-
     def self.call(input)
       instance.call(input)
     end
 
     def call(input)
-      data = input[:data]
-      return data if skip
-      prepare
-      opt = { add: true }.merge!(parse_opt)
-      r = @context.call 'window.annotate', data, opt
-      r['src']
-    end
-
-    def prepare
-      return if skip
-      ngannotate_source = File.open(File.join(File.dirname(__FILE__), '../../vendor/ngannotate.js')).read
-      @context = ExecJS.compile "window = {};" + ngannotate_source
-    end
-
-    #
-    # To allow testing assets compile in development environment
-    #
-    # To explicitly force assets compile in development environment
-    #  NG_FORCE=true RAILS_ENV=development bundle exec rake assets:clean assets:precompile
-    # or add to environments/development.rb
-    #  config.ng_annotate.process = true
-    #
-    def force
-      ENV['NG_FORCE'] == 'true'
-    end
-
-    #
-    # Skip processing in environments where it does not make sense.
-    # Override by NG_FORCE=true env variable
-    #
-    def skip
-      !force && !::Rails.configuration.ng_annotate.process
-    end
-
-    def parse_opt
-      opt = {}
-      opt_str = ENV['NG_OPT']
-      if opt_str
-        opt = Hash[opt_str.split(',').map { |e| e.split('=') }]
-        opt.symbolize_keys!
-      end
-      if ENV['NG_REGEXP']
-        opt[:regexp] = ENV['NG_REGEXP']
-      end
-      opt
+      process_data(input)
     end
   end
 end

data/lib/ngannotate/processor_common.rb

@@ -0,0 +1,113 @@
+module Ngannotate
+module ProcessorCommon
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    def name
+      'Ngannotate::Processor'
+    end
+
+    def shared_exec_context
+      @shared_exec_context ||=
+        begin
+          ::Rails.logger.info "ng-prepare"
+          ngannotate_source = File.open(File.expand_path('../../../vendor/ngannotate.js', __FILE__)).read
+          ExecJS.compile "window = {};" + ngannotate_source
+        end
+    end
+  end
+
+  def logger
+    ::Rails.logger
+  end
+
+  def process_data(input)
+    data = input[:data]
+    file = input[:filename]
+
+    handle = need_process?(input)
+    state = handle ? :process : (ignore_file?(input) ? :ignore : :skip)
+    logger.info "ng-#{state}: #{file}"
+    return data unless handle
+
+    opt = { add: true }.merge!(parse_ngannotate_options)
+    r = exec_context.call 'window.annotate', data, opt
+    r['src']
+  end
+
+  def exec_context
+    @exec_context ||= self.class.shared_exec_context
+  end
+
+  def config
+    ::Rails.configuration.ng_annotate
+  end
+
+  #
+  # Is processing done for current file. This is determined by 4 checks
+  #
+  # - config.paths
+  # - config.ignore_paths
+  # - config.process
+  # - NG_FORCE=true env option
+  #
+  def need_process?(input)
+    force_process = ENV['NG_FORCE'] == 'true'
+    process_file?(input) && (force_process || config.process)
+  end
+
+  #
+  # @return true if current file should be processed
+  #
+  def process_file?(input)
+    !ignore_file?(input) && match_input(config.paths, input)
+  end
+
+  #
+  # @return true if current file is ignored
+  #
+  def ignore_file?(input)
+    match_input(config.ignore_paths, input)
+  end
+
+  #
+  # @return truthy value if input matches any of paths
+  #
+  def match_input(paths, input)
+    file = input[:filename]
+    paths.any? do |p|
+      if p.is_a? Proc
+        p.call(file)
+      elsif p.is_a? Regexp
+        p.match(file)
+      else
+        file.index(p)
+      end
+    end
+  end
+
+  #
+  # Parse extra options for ngannotate
+  #
+  def parse_ngannotate_options
+    opt = config.options.clone
+
+    if ENV['NG_OPT']
+      opt_str = ENV['NG_OPT']
+      if opt_str
+        opt = Hash[opt_str.split(',').map { |e| e.split('=') }]
+        opt.symbolize_keys!
+      end
+    end
+
+    regexp = ENV['NG_REGEXP']
+    if regexp
+      opt[:regexp] = regexp
+    end
+
+    opt
+  end
+end
+end

data/lib/ngannotate/rails/railtie.rb

@@ -8,11 +8,27 @@ end
 module Ngannotate
   module Rails
     class Railtie < ::Rails::Railtie
-      config.ng_annotate = ActiveSupport::OrderedOptions.new
+      config.before_configuration do |app|
+        config.ng_annotate = ActiveSupport::OrderedOptions.new
+        ng = config.ng_annotate
 
-      # Establish static configuration defaults
-      # Disabled by default in development and test environments
-      config.ng_annotate.process = !::Rails.env.development? && !::Rails.env.test?
+        # Establish static configuration defaults
+
+        # @see ngannotate
+        ng.options = {}
+
+        # Disabled by default in development and test environments
+        ng.process = !::Rails.env.development? && !::Rails.env.test?
+
+        # comma separate list of paths to only handle for annotation
+        # - ignore_paths entries are filtered out from this
+        ng.paths = [/.*/]
+
+        # comma separate list of paths to ignore from annotation
+        ng.ignore_paths = [
+          '/vendor/',
+        ]
+      end
 
       initializer "ngannotate-rails.add_ngannotate_postprocessor", :group => :all do |app|
         app.assets.register_postprocessor 'application/javascript', Ngannotate::Processor

data/lib/ngannotate/rails/version.rb

@@ -1,5 +1,5 @@
 module Ngannotate
   module Rails
-    VERSION = "0.15.4.1"
+    VERSION = "1.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ngannotate-rails
 version: !ruby/object:Gem::Version
-  version: 0.15.4.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Kari Ikonen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-15 00:00:00.000000000 Z
+date: 2015-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -84,6 +84,7 @@ files:
 - lib/ngannotate.rb
 - lib/ngannotate/processor.rb
 - lib/ngannotate/processor3.rb
+- lib/ngannotate/processor_common.rb
 - lib/ngannotate/rails.rb
 - lib/ngannotate/rails/railtie.rb
 - lib/ngannotate/rails/version.rb