rugular 0.7.4 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ebd5fd0979555bfd85512d5ab692c2e652935224
-  data.tar.gz: 5487187d16e573444d32db35ddc5a4d95ec16fe9
+  metadata.gz: 139ae72be05b9e5148a8fc18e9b0dc4ce0d41b73
+  data.tar.gz: 8c62061df101cbf404bf784aa640b216779edf80
 SHA512:
-  metadata.gz: d9944738a6f928b77052302c8ef59d8a4d6e9e1dc632f4d78e5820a7935ba159d60449b5b55ecece23fa6a220a9f292abc74136b3e21a995b716e9b2d3212cfd
-  data.tar.gz: 23e468d9d7bcfccf82809576cce999bd7a2975b101f88af62b9bb8470f735684b5cc4e01fe4f50fda0915a2ecdd43058397ea58581aca12bbe1801f96c462142
+  metadata.gz: 47f6ede885b6538d37509ba5ef687c18754f2979453768cddc629c3f81517e81f142cc2c7b3ee773cee86f9d4f2df255d1303bd032e2e71c262244d1b9ec113e
+  data.tar.gz: 609fa6b7461e249a89bad153472e89cf47305f578e03aad846d87b8012c6ee81efc836f346fe6c8f0048dedc8c84bed7014d3e944975669e36e9f7a378c4aae0

data/.ruby-version

@@ -1 +1 @@
-2.2.0
+2.2.1

data/README.md

@@ -44,9 +44,11 @@ A new Rugular project contains the following folders and files:
 ├──  .tmp/
 ├──  bower_components/
 ├──  bower.json
+├──  dist/
 ├──  Gemfile
 ├──  node_modules/
 ├──  package.json
+├──  release/
 ├──  src/
 │   ├──  app/
 │   │   ├──  _app.sass
@@ -70,9 +72,11 @@ A new Rugular project contains the following folders and files:
 | .tmp | A temporary folder used for storing compiled Haml, Sass, and Coffeescript file, you do not need to edit any files in this folder. |
 | bower_components | A folder used by bower to install packages. |
 | bower.json | A list of packages to be installed by bower. |
+| dist | A folder that contains production files created by the rugular build command |
 | Gemfile | A way to install the ``rugular`` gem locally. This is not needed if you install ``rugular`` globally. |
 | node_modules | A folder used by npm to install packages. |
 | package.json | A list of packages to be installed by npm. |
+| release | A folder that contains a manifest files to be used as a bower_component |
 | src | A folder containing the source code unique to a rugular application. |
 | src/app | A folder for application code that correlates to the layout of the application and a URL route in the application. A section is detailed below about [How to Write Rugular apps](#how-to-write-rugular-apps). |
 | src/components | A folder for isolate-scope directives to be used in your application code. This folder is also described in [How to Write Rugular apps](#how-to-write-rugular-apps). |
@@ -89,7 +93,9 @@ bower_components or other 3rd party vendor files are declared in the
 Code in the src folder are written in Coffeescript, Haml and Sass and designed
 to follow [Google's Best Practices for an Angular App
 Structure](https://docs.google.com/document/d/1XXMvReO8-Awi1EZXAXS4PzDzdNvV6pGcuaF4Q9821Es/pub).
-Rugular initially creates a ``src/app`` folder for logic pertaining to urls and an ``src/components`` folder for abstracted web components, written as Angular directives.
+Rugular initially creates a ``src/app`` folder for logic pertaining to urls and
+an ``src/components`` folder for abstracted web components, written as Angular
+directives.
 
 ### The src/app folder
 
@@ -232,8 +238,8 @@ src/app/navbar.haml
 src/app/navbar.module.coffee
 ```
 
-> This will be re-written as a component in Angular 2.0.
-> (and it will be awesome!)
+> This will be re-written as a component in Angular 2.0. (and it will be
+> awesome!)
 
 #### Create a Factory
 
@@ -297,6 +303,37 @@ start a new tmuxinator session, type:
 bundle exec rugular tmux
 ```
 
+## Abstracting Bower Components
+
+Rugular allows users to abstract both the ``components`` and ``app`` folder as
+one bower_component, or just the ``components`` folder as a bower_component. A
+new manifest file will be created in the ``release`` folder of your application
+and the version in the ``bower.json`` file will be updated.
+
+### App and Components Bower Component
+
+To create a bower component with both the ``app`` and ``components`` folder
+run:
+
+```bash
+bundle exec rugular abstract
+```
+
+This will create the manifest ``release/#{your_app_name}.js`` file. Running
+this command multiple times will override the file.
+
+### Components Bower Component
+
+To create a bower component with both the ``app`` and ``components`` folder
+run:
+
+```bash
+bundle exec rugular abstract -c
+```
+
+This will also create the manifest ``release/#{your_app_name}.js`` file.
+Running this command multiple times will override the file.
+
 ## Running the tests
 
 ### During development

data/features/abstract.feature

@@ -2,22 +2,31 @@
 Feature: Rugular CLI
   In order to abstract bower components
   As a user of the rugular framework
-  I want to create a bower_component from any component folder
+  I want to create a bower_component from my rugular application
 
   # Scenario: Abstracting components folder
-  #   When I set up Rugular and run "rugular g directive test"
-  #   And I run `cd tmp/aruba/my-app && rugular abstract -c`
-  #   Then the file "~/bower_components/myapp/bower.json" should contain:
+  #   When I set up Rugular and run "rugular g directive test && rugular abstract -c"
+  #   Then the file "my-app/bower.json" should contain:
   #   """
-  #   "private": true,
+  #   "version": "0.0.0",
   #   """
-  #
+  #   And a file named "my-app/release/my-app.js" should exist
+  #   And a file named "my-app/release/my-app.css" should exist
+
   # Scenario: Abstracting both the app and components folder
-  #   When I set up Rugular and run "rugular g directive test"
-  #   And I run `cd tmp/aruba/my-app && rugular abstract`
-  #   Then the file "~/bower_components/myapp/bower.json" should contain:
+  #   When I set up Rugular and run "rugular g directive test && rugular abstract"
+  #   Then the file "my-app/bower.json" should contain:
   #   """
-  #   "private": true,
+  #   "version": "0.0.0",
   #   """
+  #   And a file named "my-app/release/my-app.js" should exist
+  #   And a file named "my-app/release/my-app.css" should exist
   #
-  #
+  Scenario: Abstracting both the app and components folder twice
+    When I set up Rugular and run "rugular g directive test && rugular abstract && rugular abstract"
+    Then the file "my-app/bower.json" should contain:
+    """
+    "0.0.1"
+    """
+    And a file named "my-app/release/my-app.js" should exist
+    And a file named "my-app/release/my-app.css" should exist

data/features/build.feature

@@ -0,0 +1,14 @@
+@increase_wait_time
+Feature: Rugular CLI
+  In order to create production files
+  As a user of the rugular framework
+  I want to create manifest js and css files
+
+  Scenario: Building the dist folder
+    When I set up Rugular and run "cd tmp/aruba/my-app && rugular build`
+    Then a file named "tmp/aruba/myapp/dist/index.html" should exist
+    Then a file named "tmp/aruba/myapp/dist/application.css" should exist
+    Then a file named "tmp/aruba/myapp/dist/application.js" should exist
+    Then a file named "tmp/aruba/myapp/dist/vendor.css" should exist
+    Then a file named "tmp/aruba/myapp/dist/vendor.js" should exist
+

data/features/generator_for_directive.feature

@@ -4,7 +4,7 @@ Feature: Rugular CLI
   I want to bootstrap the templates necessary to carry this out
 
   Scenario: Generating a route
-    When I set up Rugular and run "rugular generate directive test"
+    When I set up Rugular and run "rugular generate directive -c test"
     Then the file "my-app/src/components/test/test.directive.coffee" should contain:
       """
       angular.module('test').directive('test', test)

data/lib/rugular/tasks/abstract.rb

@@ -1,17 +1,22 @@
+Dir.glob("#{__dir__}/helpers/**/*.rb").each { |file| require file }
+require 'uglifier'
+require 'coffee_script'
+require 'sass'
+require 'haml'
+
 module Rugular
   class Abstract < Thor::Group
     include Thor::Actions
 
-    argument :folder, desc: 'Component folder you want to abstract'
+    class_option(
+      :c,
+      type: :boolean,
+      desc: 'Create a component with just the component folder'
+    )
+
     desc <<-DESC
-      The abstract command copies the contents of any folder nested one-level
-      beneath ``src/components`` into the ``~/bower_components`` folder where
-      it is treated like a bower component.
-
-      The command will ask some setup questions to generate a bower.json. It is
-      recommended that the bower component folders generated by rugular are NOT
-      edited by hand. Instead, the only updates should occur by repeated use of
-      the ``rugular abstract`` command.
+      Creates a release manifest javascript file to be used as a bower
+      component
     DESC
 
     def check_for_rugular_directory
@@ -21,79 +26,82 @@ module Rugular
       )
     end
 
-    def initialize_or_create_version
-
+    def bower_json
+      @_json ||= JSON.parse(File.read('bower.json')).to_h
     end
 
-    def file_copy_folder_into_bower_src_folder
-      directory component_directory, bower_component_directory
-    end
+    def increment_bower_version_if_file_exists
+      return unless File.exists? "release/#{app_name}.js"
 
-    def create_bower_file
-      return if bower_component_bower_json?
+      new_bower_json = bower_json.tap do |json|
+        json['version'] = next_version
+      end
 
-      create_file "#{bower_component_directory}/bower.json" do
-        ERB.new(bower_template_file).result(
-          bower_open_struct.instance_eval { binding }
-        )
+      File.open('bower.json', 'w') do |file|
+        file.write new_bower_json
       end
     end
 
-    private
+    def write_release_js_file
+      File.open(release_js, 'w') do |file|
+        file.write(
+          Uglifier.compile(
 
-    def bower_component_bower_json?
-      File.exists? bower_component_directory
-    end
+            javascript_files.map do |javascript_file|
+              CoffeeScript.compile(
+                File.read(javascript_file).gsub('templateUrl', 'template')
+              )
+            end.join
 
-    def bower_component_bower_json
-      JSON.parse(File.read("#{bower_component_directory}/bower.json"))
+          )
+        )
+      end
     end
 
-    def previous_version
-      return 'not defined' unless bower_component_bower_json?
+    def inline_template_url_files
+      (Dir.glob('**/*.haml') - ['src/index.haml']).each do |haml_file|
+        haml_html = ::Haml::Engine.new(File.read(haml_file), {}).render
 
-      bower_component_bower_json.fetch('version', '0.0.0')
-    end
+        html = haml_html.tr("\n", '').gsub("'", "\'").gsub('"', '\"')
 
-    def bower_json
-      JSON.parse(File.read('bower.json'))
-    end
+        html_filename = haml_file.gsub('src/', '').gsub('haml', 'html')
 
-    def git_username
-      "#{`git config user.name`.strip} <#{`git config user.email`.strip}>"
+        IO.write(release_js, File.open(release_js) do |f|
+          f.read.gsub(html_filename, html)
+        end)
+      end
     end
 
-    def bower_component_directory
-      "#{Dir.home}/bower_components/#{folder}"
+    def write_application_css_file
+      `sass .application.sass release/#{app_name}.css -r sass-globbing`
     end
 
-    def component_directory
-      "./src/components/#{folder}/"
+    private
+
+    def app_name
+      destination_root.split('/').last
     end
 
-    def main_javascript_files
-      Dir.glob("#{component_directory}/*").map do |filename|
-        File.basename(filename)
-      end
+    def previous_version
+      bower_json.fetch('version')
     end
 
-    def bower_open_struct
-      OpenStruct.new(
-        name: folder,
-        version: @version,
-        git_username: git_username,
-        description: folder,
-        main_javascript_files: main_javascript_files,
-        dev_dependencies: bower_json.fetch('devDependencies', {}),
-        dependencies: bower_json.fetch('dependencies', {}),
-        resolutions: bower_json.fetch('resolutions', {})
-      )
+    def next_version
+      next_patch = previous_version.split('.').last.to_i + 1
+
+      (previous_version.split('.')[0..-2] << next_patch).join('.')
     end
 
-    def bower_template_file
-      lib_directory = __dir__.chomp('/tasks')
+    def javascript_files
+      if options[:c]
+        ::Rugular::JavascriptFiles.component_array
+      else
+        ::Rugular::JavascriptFiles.ordered_array
+      end
+    end
 
-      File.read("#{lib_directory}/templates/abstract/bower.json")
+    def release_js
+      "release/#{app_name}.js"
     end
   end
 end

data/lib/rugular/tasks/build.rb

@@ -11,11 +11,10 @@ module Rugular
     desc('Creates a minified, compressed version in the dist folder')
 
     def check_for_rugular_directory
-      Rugular::AppChecker.check_rugular!(self.name, new.destination_root)
-    end
-
-    def create_dist_folder
-      FileUtils.mkdir_p('./dist') unless File.directory? './dist'
+      Rugular::AppChecker.check_for_rugular_directory(
+        task_name: name,
+        root_directory: new.destination_root
+      )
     end
 
     def write_dist_index_html_file
@@ -40,10 +39,13 @@ module Rugular
       File.open('dist/application.js', 'w') do |file|
         file.write(
           Uglifier.compile(
-            Rugular::JavascriptFiles.map do |javascript_file|
+
+            Rugular::JavascriptFiles.ordered_array.map do |javascript_file|
               text = File.read(javascript_file).gsub('templateUrl', 'template')
+
               CoffeeScript.compile(text)
             end.join
+
           )
         )
       end
@@ -52,8 +54,11 @@ module Rugular
     def inline_template_url_files
       (Dir.glob("**/*.haml") - ["src/index.haml"]).each do |haml_file|
         haml_html = ::Haml::Engine.new(File.read(haml_file), {}).render
+
         html = haml_html.tr("\n", '').gsub("'", "\'").gsub('"', '\"')
+
         html_filename = haml_file.gsub('src/', '').gsub('haml', 'html')
+
         IO.write('dist/application.js', File.open('dist/application.js') do |f|
           f.read.gsub(html_filename, html)
         end)

data/lib/rugular/tasks/generate/generator_base.rb

@@ -7,6 +7,12 @@ module Rugular
 
     argument :name, desc: 'Name for your route'
 
+    class_option(
+      :c,
+      type: :boolean,
+      desc: 'create the route in the component folder'
+    )
+
     def self.source_root
       __dir__.chomp('/tasks/generate')
     end
@@ -42,7 +48,6 @@ module Rugular
     end
 
     def template_files; []; end
-    def app_or_component; 'components' end
 
     protected
 
@@ -100,5 +105,9 @@ module Rugular
       "src/#{app_or_component}/#{name.split(':')[0..-2].join('/')}/"\
         "#{nested_module_name}.module.coffee"
     end
+
+    def app_or_component
+      options[:c] ? 'components' : 'app'
+    end
   end
 end

data/lib/rugular/tasks/helpers/javascript_files.rb

@@ -1,12 +1,7 @@
 module Rugular
   class JavascriptFiles
     def self.ordered_array
-      Dir.glob('src/components/**/*.module.coffee') +
-        Dir.glob('src/components/**/*.constant.coffee') +
-        Dir.glob('src/components/**/*.factory.coffee') +
-        Dir.glob('src/components/**/*.filter.coffee') +
-        Dir.glob('src/components/**/*.controller.coffee') +
-        Dir.glob('src/components/**/*.directive.coffee') +
+      component_array +
         Dir.glob('src/app/**/*.module.coffee') +
         Dir.glob('src/app/**/*.config.coffee') +
         Dir.glob('src/app/**/*.constant.coffee') +
@@ -14,5 +9,14 @@ module Rugular
         Dir.glob('src/app/**/*.controller.coffee') +
         Dir.glob('src/app/**/*.routes.coffee')
     end
+
+    def self.component_array
+      Dir.glob('src/components/**/*.module.coffee') +
+        Dir.glob('src/components/**/*.constant.coffee') +
+        Dir.glob('src/components/**/*.factory.coffee') +
+        Dir.glob('src/components/**/*.filter.coffee') +
+        Dir.glob('src/components/**/*.controller.coffee') +
+        Dir.glob('src/components/**/*.directive.coffee')
+    end
   end
 end

data/lib/rugular/tasks/new.rb

@@ -36,6 +36,14 @@ module Rugular
       empty_directory "#{app_name}/vendor"
     end
 
+    def create_dist_directory
+      empty_directory "#{app_name}/dist"
+    end
+
+    def create_release_directory
+      empty_directory "#{app_name}/release"
+    end
+
     def install_bourbon
       run "cd #{app_name}/vendor && bourbon install "\
         '&& neat install && bitters install'

data/lib/rugular/templates/new_erb/bower.json.erb

@@ -2,6 +2,7 @@
   "name": "<%= name %>",
   "version": "0.0.0",
   "description": "",
+  "main": ["release/<%= name %>.js", "release/<%= name %>.css"],
   "authors": [
   ],
   "license": "Copyright by the code's authors on the master branch of this repository",

data/lib/rugular/version.rb

@@ -1,3 +1,3 @@
 module Rugular
-  VERSION = '0.7.4'
+  VERSION = '0.8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rugular
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.8.0
 platform: ruby
 authors:
 - Nicholas Shook
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-11 00:00:00.000000000 Z
+date: 2015-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -309,6 +309,7 @@ files:
 - bower.json
 - circle.yml
 - features/abstract.feature
+- features/build.feature
 - features/continuous_integration.feature
 - features/generator_for_directive.feature
 - features/generator_for_route.feature
@@ -410,6 +411,7 @@ specification_version: 4
 summary: Rugular - a ruby scaffolding framework for AngularJS
 test_files:
 - features/abstract.feature
+- features/build.feature
 - features/continuous_integration.feature
 - features/generator_for_directive.feature
 - features/generator_for_route.feature