angular_config 0.3.0

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+cache: bundler
+rvm:
+  - 1.9.3
+  - 2.2.0
+install: bundle install
+script: bundle exec rake test

data/Gemfile

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

data/README.md

@@ -0,0 +1,87 @@
+# AngularConfig
+[![Build Status](https://travis-ci.org/cultuurnet/angular-config.png)](https://travis-ci.org/cultuurnet/angular-config)
+
+This tool allows you to inject a JSON configuration into a minified Angular application. It inserts checksummed versions of the
+configuration keys as values during the build process, and provides a mechanism to exchange these keys with the actual values when deploying.
+
+This is a hackish solution, but it allows swapping configuration values without having to rebuild the application and does not require changes
+to existing angular code.
+If you are able to change the angular code, a solution like deferred bootstrapping is probably better suited.
+
+I created it because, in continuous delivery fashion, I needed to be able to build an application artifact once and deploy it to a number of
+different environments, with only the configuration changing. As minified Angular applications typically embed the configuration in the javascript,
+this is what I came up with.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'angular_config'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install angular_config
+
+## Usage
+
+### Commandline tool
+
+Create a hashed version of the config.json first:
+
+    $ angular_config hash -c config.json -t md5 > hashed_config.json
+
+Now build the angular app using the hashed configuration file.
+
+After that, exchange the config values for the real ones:
+
+    $ angular_config resolve -t md5 -c config_production.json -f scripts.js
+
+If you use cache busting (embedding the md5 hash of the file source in the filename and
+referencing that from the index.html), you will need the calculate a new md5 sum for the
+changed file, rename and reference accordingly.
+
+### Programmatically
+
+Create a hashed version of the config.json first:
+
+```
+require 'angular_config'
+
+config = AngularConfig::Config.load('config.json', 'md5')
+puts config.hash_values.content.to_json
+```
+
+Now build the angular app using the hashed configuration file.
+
+After that, exchange the config values for the real ones:
+
+```
+require 'angular_config'
+
+config_hashed_keys = AngularConfig::Config.load('config.json', 'md5').hash_keys
+file = AngularConfig::Source.load('source.js')
+
+puts file.resolve(config_hashed_keys).content
+```
+
+If you use cache busting (embedding the md5 hash of the file source in the filename and
+referencing that from the index.html), you will need the calculate a new md5 sum for the
+changed file, rename and reference accordingly.
+
+## Development
+
+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).
+
+## Contributing
+
+1. Fork it ( https://github.com/cultuurnet/angular_config/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

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:test) do |t|
+  t.pattern = Dir.glob('spec/**/*_spec.rb')
+  t.rspec_opts = '--format documentation'
+end
+
+desc "Default task prints the available targets."
+task :default do
+    system("rake -T")
+end

data/angular_config.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'angular_config/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "angular_config"
+  spec.version       = AngularConfig::VERSION
+  spec.authors       = ["Kristof Willaert"]
+  spec.email         = ["kristof.willaert@cultuurnet.be"]
+
+  spec.summary       = %q{Manage configuration in minified/uglified Angular apps}
+  spec.description   = %q{Manage configuration in minified/uglified Angular apps by swapping out cryptographically hashed values}
+  spec.homepage      = "https://github.com/cultuurnet/angular_config"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "fakefs", "~> 0.10"
+end

data/bin/angular_config

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'angular_config'
+
+options = {:type => 'SHA256'}
+
+angular_config = OptionParser.new do |ac|
+  ac.banner = "Usage: angular_config COMMAND [OPTIONS]"
+  ac.separator  ""
+  ac.separator  "Commands"
+  ac.separator  "     hash: convert values of a JSON hash to hashed representations of the keys"
+  ac.separator  "     resolve: resolve hashed keys in a file with actual values"
+  ac.separator  ""
+  ac.separator  "Options"
+
+  ac.on("-c","--config CONFIG","Configuration file containing source JSON hash") do |config|
+    options[:source_config] = config
+  end
+
+  ac.on("-f","--file FILE","File to resolve") do |file|
+    options[:file] = file
+  end
+
+  ac.on("-t","--type TYPE","Checksum type to use") do |type|
+    options[:type] = type
+  end
+
+  ac.on("-h","--help","help") do
+    puts angular_config
+  end
+end
+
+angular_config.parse!
+
+case ARGV[0]
+when "hash"
+  unless options[:source_config].nil?
+    source_config = AngularConfig::Config.load(options[:source_config], options[:type])
+    puts source_config.hash_values.content.to_json
+  else
+    puts angular_config
+  end
+when "resolve"
+  unless options[:source_config].nil? or options[:file].nil?
+    config_hashed_keys = AngularConfig::Config.load(options[:source_config], options[:type]).hash_keys
+    file = AngularConfig::Source.load(options[:file])
+
+    puts file.resolve(config_hashed_keys).content
+  else
+    puts angular_config
+  end
+else
+  puts angular_config
+end

data/lib/angular_config.rb

@@ -0,0 +1,5 @@
+require 'json'
+require 'digest'
+require 'angular_config/file'
+require 'angular_config/config'
+require 'angular_config/source'

data/lib/angular_config/config.rb

@@ -0,0 +1,44 @@
+module AngularConfig
+  class Config
+    attr_reader :content
+    attr_reader :checksum_type
+
+    def initialize(config = {}, type = 'SHA256')
+      @content = config
+      @checksum_type = type.upcase
+    end
+
+    def hash_keys
+      hashed_keys = content.each_with_object({}) do |(key, value), result|
+        digest = load_constant("Digest::#{checksum_type}").new
+        result[digest.hexdigest(key)] = value
+      end
+      AngularConfig::Config.new(hashed_keys)
+    end
+
+    def hash_values
+      hashed_values = content.each_with_object({}) do |(key, value), result|
+        digest = load_constant("Digest::#{checksum_type}").new
+        result[key] = digest.hexdigest(key)
+      end
+      AngularConfig::Config.new(hashed_values)
+    end
+
+    def self.load(path, type = 'SHA256')
+      AngularConfig::Config.new(JSON.load(AngularConfig::File.new(path).content), type)
+    end
+
+    def self.save(data, path)
+      AngularConfig::File.new(path).content = data.to_json
+    end
+
+    private
+
+    def load_constant(name)
+      parts = name.split('::')
+      klass = Module.const_get(parts.shift)
+      klass = klass.const_get(parts.shift) until parts.empty?
+      klass
+    end
+  end
+end

data/lib/angular_config/file.rb

@@ -0,0 +1,19 @@
+module AngularConfig
+  class File
+    attr_reader :path
+
+    def initialize(source_path)
+      @path = ::File.expand_path(source_path)
+    end
+
+    def content
+      ::File.read(path).chomp
+    end
+
+    def content=(data)
+      ::File.open(path, "w") do |file|
+        file.write(data)
+      end
+    end
+  end
+end

data/lib/angular_config/source.rb

@@ -0,0 +1,33 @@
+module AngularConfig
+  class Source
+    attr_reader :content
+
+    def initialize(content)
+      @content = content
+    end
+
+    def md5
+      Digest::MD5.hexdigest(content)
+    end
+
+    def resolve(hashed_keys)
+      hashed_keys.content.each do |key, value|
+        if value.is_a?(String)
+          self.content.gsub!(key, value)
+        else
+          self.content.gsub!("\"#{key}\"", value.to_json)
+        end
+      end
+
+      self
+    end
+
+    def self.load(path)
+      AngularConfig::Source.new AngularConfig::File.new(path).content
+    end
+
+    def self.save(data, path)
+      AngularConfig::File.new(path).content = data
+    end
+  end
+end

data/lib/angular_config/version.rb

@@ -0,0 +1,3 @@
+module AngularConfig
+  VERSION = "0.3.0"
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: angular_config
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+  prerelease: 
+platform: ruby
+authors:
+- Kristof Willaert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Manage configuration in minified/uglified Angular apps by swapping out
+  cryptographically hashed values
+email:
+- kristof.willaert@cultuurnet.be
+executables:
+- angular_config
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- angular_config.gemspec
+- bin/angular_config
+- lib/angular_config.rb
+- lib/angular_config/config.rb
+- lib/angular_config/file.rb
+- lib/angular_config/source.rb
+- lib/angular_config/version.rb
+homepage: https://github.com/cultuurnet/angular_config
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23.2
+signing_key: 
+specification_version: 3
+summary: Manage configuration in minified/uglified Angular apps
+test_files: []