atd 0.1.0.TEST.GITLAB1 → 0.2.0.TEST.GITLAB1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7632cff0dea940480d94ff9edf270c40cb867d84
-  data.tar.gz: 51bb58c9651e635c8ed24d15a5f1ae1f7af3915f
+  metadata.gz: 5aee51c24722e0377807e99f47cbe847ceab08db
+  data.tar.gz: 7ce85f825e084f24fdcebd4bfe1ae835af651959
 SHA512:
-  metadata.gz: b47eb2b7b87ba4fa7b62f73a32da06c2e239b0aed06f63812fed6d3c94596a093a483be6b8594f236ef1d33059bcbf22916cf20e095d747b6a73f0b16feb3b82
-  data.tar.gz: 42c78f99c567e0b102b0b2138696a9de72291ac15295fd400ef49533535a73c7c1ceb69dffe332ae3dafc482235eb21695da1929ac90a84c960d2e641346a4bc
+  metadata.gz: cea8be538401bbc9e7c466928afc3bb8357b8d5b9feababd544373c91630bf52e6ad77f220e9a6606f463322505b511ed7bbff51d60bfa86bb83d78bf588c004
+  data.tar.gz: 9a6f3bd0188a78d9706c473d4446992ab2f758d18a16d6524f088e4057ddedf76ed09c3d7ab2b92da418dd33e06b53a7987d82bf5073f8c85ea50b0b9896d107

data/CHANGELOG

@@ -1,5 +1,14 @@
 Repository Version:
-    - Nothing different
+
+v0.2.0
+    - Changed git workflow, now with 2 branches.
+    - Fixed some broken compiler issues
+    - Allowed routes to skip precompilation with precompile: false
+    - Changed :methods to :respond_to
+    - Allowed :ignore [http_methods] syntax
+    - Added documentation for routes.rb
+    - Updated README, added modification of instances feature
+    - Minor restructuring
 
 v0.1.0:
     - Created CHANGELOG!

data/README.md

@@ -1,6 +1,6 @@
 [![build status][build status badge]][build status link] [![coverage report][coverage report badge]][coverage report link] [![gem version][gem version badge]][gem version link] [![documentation coverage][documentation coverage badge]][documentation coverage link]
 
-[documentation coverage badge]: https://img.shields.io/badge/YARD%20coverage-77.50%-yellow.svg?style=flat-square
+[documentation coverage badge]: https://img.shields.io/badge/YARD%20coverage-93.02%-green.svg?style=flat-square
 [documentation coverage link]: http://izwick-schachter.gitlab.io/atd/YARD/coverage
 
 [build status badge]: https://gitlab.com/izwick-schachter/atd/badges/master/build.svg?style=flat-square
@@ -34,21 +34,23 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Or install it from the repository with:
 
     $ git clone https://gitlab.com/izwick-schachter/atd.git
     $ cd atd
     $ bundle exec rake install
 
+This will also allow you to use the current development version (USE WITH CAUTION), and to use that you can `git checkout development` and then `bundle exec rake install`. 
+
 ## Usage
 
 ### Setup
 
 Setup is as easy as `require "atd"` at the top of whatever file you need it in
 
-### Routing
+## Routing
 
-#### Basic Routing
+### Basic Routing
 
 On the lowest level it can be used serve files or any strings when a path is requested (and optionally when a specific HTTP method is used). Here is a basic route that will serve `Hello World` when `/` is sent any HTTP request (`GET`, `POST`, `PUT`, `PATCH`, `DELETE`):
 
@@ -100,7 +102,38 @@ Or, a simpler way would be with `:ignore`:
 request "/", "Hello World", ignore: :delete
 ```
 
-#### Advanced Routing
+### Advanced Routing
+
+#### DefaultApp
+
+`DefaultApp` is just another app which extends `ATD::App`, it is the app which doesn't have to be written to in `class DefaultApp`, any routes that are created in `main` will be added to `DefaultApp`, well... by default!
+
+#### Inheritance
+
+Whenever you create a route, it is given to an App Class (which inherits from `ATD::App`). This isn't apparent when you create a route in `main`, but even when you do that the route is added to `DefaultApp`. If you are using Apps, than when you create a route in the App Class, that route is given to that Class. When you start the server, it then creates an instance of the App Class and starts it as a rack app. But that is not what the purpose of Apps are.
+
+The intention of Apps are to allow you to use one App Class as a template class, from which you can create many different apps. An App Class is not a rack app all by itself. Every instance of an App Class is a rack app. But the rack app doesn't actually start until `start` is called. This means that you can create an instance of an App Class (an App), and then you can modify it before starting it. So for example, you can have an app which is impacted by an instance variable:
+
+```ruby
+class MyApp < ATD::App
+  attr_accessor :my_name
+  request "/", "Hi! This is my_name's App!" do
+    @http[:output] = @http[:output].gsub("my_name", @my_name)
+  end
+end
+```
+
+Which you can then create an instance of and modify the instance variable:
+
+```ruby
+app = MyApp.new
+app.my_name = "Fredrick"
+app.start
+```
+
+Then when you try to access the website, it will respond to `/` with `Hi! This is Fredrick's App!`.
+
+#### Blocks
 
 You can also add blocks to the basic routing methods to execute code when they are reached, and customize the response to the incoming request. Here is an example that will return the HTTP method used to request `/`:
 
@@ -225,4 +258,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitLab at https://gitlab.com/izwick-schachter/atd/issues. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitLab at https://gitlab.com/izwick-schachter/atd/issues. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/atd.gemspec

@@ -11,14 +11,14 @@ Gem::Specification.new do |spec|
 
   spec.summary       = 'The assistant technical director of your website. It does the dirty work so you can see the big picture.'
   spec.homepage      = "https://rubygems.org/gems/atd"
-  spec.license      = "MIT"
+  spec.license       = "MIT"
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   raise "RubyGems 2.0 or newer is required to protect against public gem pushes." unless spec.respond_to?(:metadata)
   spec.metadata['allowed_push_host'] = "https://rubygems.org"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }#+"test/assets/test.html"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]

data/lib/atd.rb

@@ -69,7 +69,7 @@ module ATD
       define_method(method) do |*args, &block|
         @method = [method] if @method.length == 5
         @method += [method]
-        @method += args.last[:methods] if args.last.is_a?(Hash) && !args.last[:methods].nil?
+        @method += args.last[:respond_to] if args.last.is_a?(Hash) && !args.last[:respond_to].nil?
         @method.uniq!
         parse_args(*args, &block)
       end
@@ -99,15 +99,16 @@ module ATD
       @path = args.shift if @path.nil?
       @output = args.shift if @output.nil?
       @args = Array(@args).concat(args) - [nil] unless args.nil?
+      @method -= Array(args.last[:ignore]) if args.last.is_a?(Hash) && !args.last[:ignore].nil?
       self
     end
   end
 
   # A template {App} that all Apps extend. When a new App is created with {ATD.new ATD.new} it extends this class.
   class App
+    attr_accessor :http
     class << self
       attr_accessor :routes # An array of instances of {ATD::Route} that belong to this {App}.
-      attr_accessor :http
 
       # Generates an instance of {ATD::Route}.
       # Passes all arguments and the block to {Route.new the constructor} and sets the app where it was called from.
@@ -129,7 +130,7 @@ module ATD
       # @param [Class] server The server that you would like to use.
       # @param [Fixnum] port The port you would like the server to run on.
       def start(server = WEBrick, port = 3150)
-        Rack::Server.start(app: self.new, server: server, Port: port)
+        Rack::Server.start(app: new, server: server, Port: port)
       end
     end
 
@@ -152,16 +153,29 @@ module ATD
     #   }
     # @param [Array] routes An array of instances of {ATD::Route}.
     def initialize(routes = [])
-      routes += self.class.routes
       @routes = {}
-      routes.each do |route|
-        filename = ATD::Compilation.pre_parse(route)
+      Array(routes + self.class.routes).each do |route|
+        filename = ATD::Compilation.pre_parse(route) if route.args.last.nil? || route.args.last[:precompile].nil? || route.args.last[:precompile]
         route_hash = route.to_h
-        route_hash[route.path][route.method][:filename] = filename
+        current_route = route_hash[route.path][route.method]
+        current_route[:filename] = filename
+        block = current_route[:block]
+        current_route[:block] = define_singleton_method(block.object_id.to_s.tr("0-9", "a-j").to_sym, &block) unless block.nil?
         @routes = @routes.to_h.deep_merge(route_hash)
       end
     end
 
+    def request(*args, &block)
+      route = ATD::Route.new(*args, &block)
+      filename = ATD::Compilation.pre_parse(route) if route.args.last.nil? || route.args.last[:precompile].nil? || route.args.last[:precompile]
+      route_hash = route.to_h
+      route_hash[route.path][route.method][:filename] = filename
+      @routes = @routes.to_h.deep_merge(route_hash)
+      route
+    end
+    alias req request
+    alias r request
+
     # Starts the rack server
     # @param [Class] server The server that you would like to use.
     # @param [Fixnum] port The port you would like the server to run on.
@@ -173,6 +187,7 @@ module ATD
     # It will return status code 200 and whatever output corresponds the that route if it exists, and if it doesn't
     # it will return status code 404 and the message "Error 404"
     def call(env)
+      @http = nil
       route = route(env)
       return error(404) if route.nil?
       route[:output] = ATD::Compilation.compile(route[:filename], route[:output])
@@ -190,12 +205,12 @@ module ATD
     end
 
     def run_block(block)
-      block.call
-      [self.class.http[:status_code].to_i, Hash(self.class.http[:headers]), Array(self.class.http[:output])]
+      method(block).call
+      [@http[:status_code].to_i, Hash(@http[:headers]), Array(@http[:output])]
     end
 
     def http(additional_params)
-      self.class.http = { status_code: 200, headers: {} }.merge(additional_params)
+      @http = { status_code: 200, headers: {} }.merge(additional_params)
     end
 
     def error(number)

data/lib/atd/routes.rb

@@ -1,21 +1,31 @@
 
 module ATD
+  # This module holds everything related to the compilation of routes.
   module Compilation
+    # A module designed to hold all the precompilation methods
     module Precompiler
       extend self
+
+      # Lists all filestypes that have defined precompiler methods
       def filetypes
         instance_methods(true) - [:filetypes]
       end
     end
+
+    # A module designed to hold all the compilation methods
     module Compiler
       extend self
+
+      # Lists all file extenstions which have defined compiler methods
       def filetypes
         instance_methods(true) - [:filetypes]
       end
     end
 
+    # This method is responsible for live compilation.
     def self.compile(name, contents)
-      return contents if name.nil?
+      return contents if name.nil? && !contents.is_a?(File)
+      name = File.basename(contents) if contents.is_a?(File)
       name = name.split(".")
       extensions = name - [name.first]
       extensions.each do |extension|
@@ -24,14 +34,15 @@ module ATD
       contents
     end
 
+    # This method is responsible for precompilation
     def self.pre_parse(route)
       output = route.output
       name = output
       return nil if output.nil?
       if output.include?(".") || output.is_a?(File)
-        file = read_file(output)
-        return nil if file.nil?
         name = (output.is_a?(File) ? File.basename(output) : output)
+        file = read_file(output)
+        return name if file.nil?
         file = precompile(name, file)
         route.output = file
       end

data/lib/atd/version.rb

@@ -1,3 +1,3 @@
 module ATD
-  VERSION = "0.1.0.TEST.GITLAB1".freeze # The current version number of {ATD}.
+  VERSION = "0.2.0.TEST.GITLAB1".freeze # The current version number of {ATD}.
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: atd
 version: !ruby/object:Gem::Version
-  version: 0.1.0.TEST.GITLAB1
+  version: 0.2.0.TEST.GITLAB1
 platform: ruby
 authors:
 - ACecretMaster
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-08 00:00:00.000000000 Z
+date: 2016-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack