lanekit 0.1.7 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YzI4ZDM1ZGM3MjhkYjRmYjU1NzkxZGM1ZDdmYzM2MjBjZTUyODgzOA==
+    M2ZkNjM1Yjk4OGNhNGQ2OWNhNTM1ZDY4Y2FhZGY1ZDE4ZThjMDA2YQ==
   data.tar.gz: !binary |-
-    MDIxOTc1ZTM4NjdiOTk2NTZjYzk2NWFjMGE1YjY0M2RiZjgzNTU5Zg==
+    MDNhY2RiNDIwMzk5ZWY5NzBlMDM4ODgxNjlhMDAxM2MyYzg0NWZhZQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    OTY4N2M1NmQxYmIzOWEwODlhOTMzMmI4YWU2OTU2YzBlY2VmYzlhMzQ5OTBm
-    Zjc5ZjkzODViMWY3MDJhZGMwYzFhYjI2MjRmMDE5MDFiNzkzNGRkMzc3YTMw
-    MWE2NTAwOTJkMjE3ZjljOGE4ZWUzY2JlMTNiZWQ4YWI4MDdiYjQ=
+    NGVhOWRlMjg2YTNiMTQ3NDZiYzU5NGE3MDUzNmIwNzRlMTMxYTViM2E3YjM1
+    ZGUxOTA5YjRhNWMxMmY3ZjBlZWFiMDkyYmI0NjQ3YTk5ZmEzZGJhODAwMDcx
+    ZDI0OWVlMmIwOGQzMzJkM2U2ZWYyMTAxODRiYTE2NWY0YmVhMmQ=
   data.tar.gz: !binary |-
-    YmFiZDM3NWQ4YzY3NGE0NjhjOWI3ZmQyNDkxZGIxODhjMDNhYzAyMTllZDRh
-    NDU4ZGZhODkzMTU4N2JiNDE1MTY0OTMxNDJhMTMzYTg2ZjZjNTliYmRmNjBj
-    MGYyYzBhNjU2OGJlNjcyMzE0YjYzN2E4NjYzMzBlNGRhYmMwY2Q=
+    N2FkYmExMzRhZmQ4OTJhMjY4NmE0YTFkYzYxNmE2NGUwNmMyZGY2YWFkZGJh
+    NjVhODE3YTc4Y2E3M2M1MmRlNmRkNTFhMmI1Y2RiMTZmZjM0OTkzMTliYWE4
+    ZDk4YzJiOWY5NWQ0ZjUwZWQ3YmQ0MTMwOGM1OTdmNjRhMGVlNTE=

data/README.md

@@ -1,6 +1,5 @@
 ## LaneKit
 
-
 LaneKit is a code generator for iOS Objective-C models for integration with RestKit. It includes support
 for unit testing with SenTestingKit including fixtures and tests. LaneKit is a command line app written
 in Ruby and packaged as a Ruby Gem.
@@ -8,6 +7,17 @@ in Ruby and packaged as a Ruby Gem.
 - [Source code for LaneKit](https://github.com/LarryAasen/LaneKit/zipball/master) from [GitHub](http://github.com).
 - Questions? [Stack Overflow](http://stackoverflow.com/questions/tagged/lanekit) is the best place to find answers.
 
+## Benefits
+* properly implemented models
+* consistent Objective-C code
+* unit tests
+* test fixtures in JSON and Objective-C
+* tested code
+* rapid development
+* easy integration with RestKit
+* enhanced productivity of junior developers
+* reduces dependency on senior developers
+
 ## How To Get Started
 
 1. Install the LaneKit Ruby Gem from RubyGems.org

data/lib/lanekit/version.rb

@@ -1,3 +1,3 @@
 module LaneKit
-  VERSION = "0.1.7"
+  VERSION = "0.2.0"
 end

data/lib/lanekit.rb

@@ -50,6 +50,23 @@ module LaneKit
     type
   end
   
+  def self.objective_c_type_fixture_json(type_name)
+    if type_name == "array"
+      value = "[]"
+    elsif type_name == "date"
+      value = "03/01/2012"
+    elsif type_name == "integer"
+      value = "1"
+    elsif type_name == "string"
+      value = "MyString"
+    elsif type_name
+      value = ""
+    else
+      value = ""
+    end
+    value
+  end
+  
   def self.objective_c_type_fixture_value(type_name)
     if type_name == "array"
       value = "@[]"
@@ -89,8 +106,19 @@ module LaneKit
     class Generate < Thor
       include Thor::Actions
 
-      desc "model [name] [name:type:relationship, name:type:relationship, ...] where type is [date|integer|string|<class_name>] and relationship (optional) is []", "Generates an Objective-C model for RestKit including unit tests"
+      desc "model NAME [attributes]", "Generates an Objective-C model for RestKit including unit tests"
+      long_desc <<-LONGDESC
+      Generates the Objective-C code for a model that is compatible with RestKit. It also generates test fixtures and unit tests.\n
+      NAME: the name of the model\n
+      [attributes] name:type:relationship, name:type:relationship, ...\n
+      where type is [date|integer|string|<class_name>] and relationship (optional) is the name of another class.
+      LONGDESC
+      
+      option :use_core_data, :type => :boolean, :default => false, :banner => "generate code compatible with Core Data", :aliases => :c     # option --use_core_data=true
       def model(model_name, *attributes)
+        @using_core_data = options[:use_core_data]
+        puts "  using Core Data: #{@using_core_data}"
+
         @model_name = LaneKit.derive_model_name(model_name)
 
         @model_file_name = LaneKit.derive_file_name(@model_name)
@@ -112,6 +140,7 @@ module LaneKit
             :objective_c_type => objective_c_type,
             :relationship => relationship,
             :relationship_fixtures_file_name => "#{relationship}Fixtures",
+            :fixture_json => LaneKit.objective_c_type_fixture_json(type),
             :fixture_value => LaneKit.objective_c_type_fixture_value(type),
             :unit_test_assert => LaneKit.objective_c_type_unit_test_assert(@model_name, name, type)
           }
@@ -142,7 +171,6 @@ module LaneKit
           @tests_models_folder = "Classes/Tests/Models"
           
           @template_folder = File.expand_path('../template', __FILE__)
-          @using_core_data = false
         end
       
         def source_paths
@@ -181,6 +209,11 @@ module LaneKit
           target = File.join(@tests_fixtures_folder, "#{@model_fixtures_file_name}.m")
           template(source,target)
 
+          # Create the json file
+          source = "model_fixture.json.erb"
+          target = File.join(@tests_fixtures_folder, "#{@model_fixtures_file_name}.json")
+          template(source,target)
+
           # 3) Create the Model Tests
           # Create the .h file
           source = "model_test.h.erb"
@@ -204,9 +237,18 @@ end
 
 module LaneKit  
   class CLI < Thor
-    desc "generate", "Generate a model compatible with RestKit that includes unit tests"
+    
+    desc "generate", "Invoke a code generator"
+    long_desc "Invoke a code generator. There is only one generator so far: 'model' that generates Objective-C code compatible with RestKit that includes unit tests"
+    subcommand "generate", LaneKit::Generators::Generate
 
     # register(class_name, subcommand_alias, usage_list_string, description_string)
-    register(LaneKit::Generators::Generate, "generate", "generate", "Runs a generator")
+    #register(LaneKit::Generators::Generate, "generate", "generate", "Runs a code generator")
+    
+    desc "version", "Display the LaneKit version"
+    
+    def version
+      puts "LaneKit #{VERSION}"
+    end
   end
 end

data/lib/template/model.h.erb

@@ -7,16 +7,19 @@
 // <%=@command%>
 //
 
-#import <Foundation/Foundation.h><% if @using_core_data %>
-#import <CoreData/CoreData.h><% end %>
+<% if @using_core_data %>#import <CoreData/CoreData.h><% else %>#import <Foundation/Foundation.h><% end %>
 
 @class RKObjectMapping;
 
-@interface <%=@class_name%> : NSObject
+@interface <%=@class_name%> : <% if @using_core_data %>NSManagedObject<% else %>NSObject<% end %>
 <% @attributes.each do |attribute| %>
 @property (nonatomic,strong) <%=attribute[:objective_c_type]%><%=attribute[:name]%>;<% if attribute[:relationship] %>  // relates to: <%=attribute[:relationship]%><% end %><% end %>
-
-+ (RKObjectMapping *)requestMapping;
-+ (RKObjectMapping *)responseMapping;
+<% if @using_core_data %>
++ (NSString *)entityName;
++ (<%=@class_name%> *)create:(NSManagedObjectContext *)moc;<% end %>
++ (NSString *)keyPath;        // Used by providers. The subset of the parsed response for which the mapping is to be used.
++ (NSString *)pathPattern;    // Used by providers. The pattern that matches against URLs for which the mapping should be used.
++ (RKObjectMapping *)requestMapping;    // Used by providers. Returns the request RKObjectMapping
++ (RKObjectMapping *)responseMapping;   // Used by providers. Returns the response RKObjectMapping
 
 @end

data/lib/template/model.m.erb

@@ -8,15 +8,36 @@
 #import "RestKit.h"<% @attributes.each do |attribute| %><% if attribute[:relationship] %>
 #import "<%=attribute[:relationship]%>.h"<%end%><%end%>
 
-@implementation <%=@class_name%>
+@implementation <%=@class_name%><% if @using_core_data %>
+
+// All properties in this NSManagedObject need to be defined with @dynamic<% @attributes.each do |attribute| %>
+@dynamic <%=attribute[:name]%>;<% end %><% end %>
 
 + (void)initialize
 {
   if (self == [<%=@class_name%> class])
   {
   }
+}<% if @using_core_data %>
+
++ (NSString *)entityName
+{
+    return NSStringFromClass([self class]);
 }
 
++ (<%=@class_name%> *)create:(NSManagedObjectContext *)moc
+{
+    <%=@class_name%> *entity = nil;
+    @try {
+        entity = [NSEntityDescription insertNewObjectForEntityForName:self.entityName inManagedObjectContext:moc];
+    }
+    @catch (NSException *exception) {
+        NSLog(@"[%@ %@] %@", [self description], NSStringFromSelector(_cmd), exception);
+        @throw exception;
+    }
+    return entity;
+}<% end %>
+
 + (NSDictionary *)dictionaryForMappings
 {
     return @{
@@ -24,7 +45,16 @@
 <% end %><% end %>    };
 }
 
-// Returns the request RKObjectMapping
++ (NSString *)keyPath
+{
+  return @"<%=@model_name%>";
+}
+
++ (NSString *)pathPattern
+{
+  return nil;
+}
+
 + (RKObjectMapping *)requestMapping
 {
     RKObjectMapping *requestMapping = [RKObjectMapping requestMapping];
@@ -32,13 +62,12 @@
     return requestMapping;
 }
 
-// Returns the response RKObjectMapping
 + (RKObjectMapping *)responseMapping
 {
     RKObjectMapping *mapping = [RKObjectMapping mappingForClass:[<%=@class_name%> class]];
     [mapping addAttributeMappingsFromDictionary:[self dictionaryForMappings]];
 <% @attributes.each_with_index do |attribute, index| %><% if attribute[:relationship] %>
-    [mapping addRelationshipMappingWithSourceKeyPath:@"<%=attribute[:name]%>" mapping:[<%=attribute[:relationship]%> modelMapping]];
+    [mapping addRelationshipMappingWithSourceKeyPath:@"<%=attribute[:name]%>" mapping:[<%=attribute[:relationship]%> responseMapping]];
 <% end %><% end %>    return mapping;
 }
 

data/lib/template/model_fixture.json.erb

@@ -0,0 +1,5 @@
+{
+  "<%=@model_name%>": {
+<% @attributes.each_with_index do |attribute, index| %><% if attribute[:relationship] %>    "<%=attribute[:relationship]%>": []<% else %>    "<%=attribute[:name]%>": "<%=attribute[:fixture_json]%>"<% if index != @attributes.size-1 %>,<% end %><% end %>
+<% end %>  }
+}

data/lib/template/model_fixture.m.erb

@@ -13,7 +13,7 @@
 {
   <%=@class_name%> *<%=@model_name%> = <%=@class_name%>.new;
 
-<% @attributes.each_with_index do |attribute, index| %><% if attribute[:relationship] %>  <%=@model_name%>.<%=attribute[:name]%> = @[<%=attribute[:relationship]%>Fixtures.one];<% else %><%=@model_name%>.<%=attribute[:name]%> = <%=attribute[:fixture_value]%>;<% end %>
+<% @attributes.each_with_index do |attribute, index| %><% if attribute[:relationship] %>  <%=@model_name%>.<%=attribute[:name]%> = @[<%=attribute[:relationship]%>Fixtures.one];<% else %>  <%=@model_name%>.<%=attribute[:name]%> = <%=attribute[:fixture_value]%>;<% end %>
 <% end %>
   return <%=@model_name%>;
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lanekit
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.0
 platform: ruby
 authors:
 - Larry Aasen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-10 00:00:00.000000000 Z
+date: 2013-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -51,6 +51,7 @@ files:
 - lib/template/model.h.erb
 - lib/template/model.m.erb
 - lib/template/model_fixture.h.erb
+- lib/template/model_fixture.json.erb
 - lib/template/model_fixture.m.erb
 - lib/template/model_test.h.erb
 - lib/template/model_test.m.erb